> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # GetBadge # Package: activity # Namespace: Badges # Method link: https://dev.wix.com/docs/api-reference/crm/members-contacts/members/activity/badges-v4/get-badge.md ## Permission Scopes: Read Badges: SCOPE.DC-MEMBERS.READ-BADGES ## Introduction Retrieves a badge by ID. --- ## REST API ### Schema ``` Method: getBadge Description: Retrieves a badge by GUID. URL: https://www.wixapis.com/badges/v4/badges/{badgeId} Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: badgeId Method parameters: param name: badgeId | type: none | required: true Return type: GetBadgeResponse - name: badge | type: Badge | description: Retrieved badge. - name: id | type: string | description: Badge GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the badge is updated. To prevent conflicting changes, the current revision must be passed when updating the badge. - name: title | type: string | description: Badge title displayed on the member's profile. - name: description | type: string | description: Badge description explaining its purpose or criteria for earning it. - name: backgroundColor | type: string | description: Badge background color in hexadecimal RGB format. - name: textColor | type: string | description: Badge text color in hexadecimal RGB format. - name: icon | type: Image | description: Badge icon image. Any image format is accepted with automatic conversion and resizing handled by the system. SVG format is recommended as it is resolution independent and looks great at any scale. - name: id | type: string | description: [WixMedia](https://support.wix.com/en/article/wix-media-about-the-media-manager) image GUID. If you pass the GUID, you don't need to pass `url`. - name: url | type: string | description: Image URL. Could be any image from the internet. - name: height | type: integer | description: Original image height. - name: width | type: integer | description: Original image width. - name: altText | type: string | description: Image alt text. - name: filename | type: string | description: Image filename. Only applicable when passing `id`. - name: permissionsEnabled | type: boolean | description: Whether the badge grants special permissions to access specific members-only pages. When `true`, members with this badge receive special permissions. Site owners can configure these permissions in the site dashboard. For more information, see [Creating and Managing Member Badges](https://support.wix.com/en/article/site-members-creating-and-managing-member-badges). - name: slug | type: string | description: URL-friendly slug for the badge, automatically generated from the title. Generated by converting the title to lowercase, replacing spaces with hyphens, and removing special characters. - name: createdDate | type: string | description: Date and time the badge was created. - name: updatedDate | type: string | description: Date and time the badge was last updated. ``` ### Examples ### Get Badge ```curl curl -X GET \ 'https://www.wixapis.com/badges/v4/badges/8046df3c-7575-4098-a5ab-c91ad8f33c47' \ -H 'Authorization: ' \ -H 'Content-Type: application/json' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.activity.Badges.getBadge(badgeId) Description: Retrieves a badge by GUID. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: badgeId Method parameters: param name: badgeId | type: string | description: Badge GUID. | required: true Return type: PROMISE - name: _id | type: string | description: Badge GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the badge is updated. To prevent conflicting changes, the current revision must be passed when updating the badge. - name: title | type: string | description: Badge title displayed on the member's profile. - name: description | type: string | description: Badge description explaining its purpose or criteria for earning it. - name: backgroundColor | type: string | description: Badge background color in hexadecimal RGB format. - name: textColor | type: string | description: Badge text color in hexadecimal RGB format. - name: icon | type: string | description: Badge icon image. Any image format is accepted with automatic conversion and resizing handled by the system. SVG format is recommended as it is resolution independent and looks great at any scale. - name: permissionsEnabled | type: boolean | description: Whether the badge grants special permissions to access specific members-only pages. When `true`, members with this badge receive special permissions. Site owners can configure these permissions in the site dashboard. For more information, see [Creating and Managing Member Badges](https://support.wix.com/en/article/site-members-creating-and-managing-member-badges). - name: slug | type: string | description: URL-friendly slug for the badge, automatically generated from the title. Generated by converting the title to lowercase, replacing spaces with hyphens, and removing special characters. - name: _createdDate | type: Date | description: Date and time the badge was created. - name: _updatedDate | type: Date | description: Date and time the badge was last updated. ``` ### Examples ### getBadge ```javascript import { badgesV2 } from '@wix/members'; async function getBadge(badgeId) { const response = await badgesV2.getBadge(badgeId); }; ``` ### getBadge (with elevated permissions) ```javascript import { badgesV2 } from '@wix/members'; import { auth } from '@wix/essentials'; async function myGetBadgeMethod(badgeId) { const elevatedGetBadge = auth.elevate(badgesV2.getBadge); const response = await elevatedGetBadge(badgeId); } ``` ### getBadge (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { badgesV2 } from '@wix/members'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { badgesV2 }, // Include the auth strategy and host as relevant }); async function getBadge(badgeId) { const response = await myWixClient.badgesV2.getBadge(badgeId); }; ``` ---