> 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 # QueryBadgeAssignments # Package: activity # Namespace: BadgeAssignments # Method link: https://dev.wix.com/docs/api-reference/crm/members-contacts/members/activity/badge-assignments/query-badge-assignments.md ## Permission Scopes: Read Badges: SCOPE.DC-MEMBERS.READ-BADGES ## Introduction Retrieves a list of badge assignments, given the provided paging, filtering, and sorting. Query Badge Assignments runs with these defaults, which you can override: - `cursorPaging.limit` is `100` To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language), [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination), and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection). --- ## REST API ### Schema ``` Method: queryBadgeAssignments Description: Retrieves a list of badge assignments, given the provided paging, filtering, and sorting. Query Badge Assignments runs with these defaults, which you can override: - `cursorPaging.limit` is `100` To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language), [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination), and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection). URL: https://www.wixapis.com/v4/badge-assignments/query Method: POST Method parameters: param name: query | type: CursorQuery - name: cursorPaging | type: CursorPaging | description: Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. - name: limit | type: integer | description: Maximum number of items to return in the results. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. - name: filter | type: object | description: Filter object. Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#filters). - name: sort | type: array | description: Sort object. Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#sorting). - name: fieldName | type: string | description: Name of the field to sort by. - name: order | type: SortOrder | description: Sort order. - enum: ASC, DESC Return type: QueryBadgeAssignmentsResponse - name: badgeAssignments | type: array | description: List of badge assignments matching the query criteria. - name: id | type: string | description: Badge assignment GUID. - name: badgeId | type: string | description: GUID of the badge being assigned to the member. Call the [Badges API](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/badges-v4/introduction.md) to retrieve available badges. - name: memberId | type: string | description: GUID of the member receiving the badge assignment. Call the [Members API](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/members/introduction.md) to retrieve member information. - name: createdDate | type: string | description: Date and time the badge assignment was created. - name: updatedDate | type: string | description: Date and time the badge assignment was updated. - name: tags | type: Tags | description: Tags allow you to classify ticket reservations. Learn more about [tags](https://dev.wix.com/docs/rest/business-management/tags/introduction.md). - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors. - name: tagIds | type: array | description: List of tag GUIDs - name: tags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. - name: extendedFields | type: ExtendedFields | description: Extended fields allow you to add custom properties beyond the standard reservation data. Learn more about [extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md). - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: pagingMetadata | type: CursorPagingMetadata | description: Paging metadata including cursors for pagination. - name: count | type: integer | description: Number of items returned in the response. - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. ``` ### Examples ### Query Badge Assignments ```curl curl -X POST \ https://www.wixapis.com/badges/v4/assignments/query \ -H 'Authorization: ' \ -H 'Content-Type: application/json' \ -d '{ "query": { "filter": { "memberId": "d9c0e118-308e-4c94-9a91-c8bb0017062c" } } }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.activity.BadgeAssignments.queryBadgeAssignments(query) Description: Retrieves a list of badge assignments, given the provided paging, filtering, and sorting. Query Badge Assignments runs with these defaults, which you can override: - `cursorPaging.limit` is `100` To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language), [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination), and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection). # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: query Method parameters: param name: query | type: BadgeAssignmentQuery | required: true - name: cursorPaging | type: CursorPaging | description: Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. - name: limit | type: integer | description: Maximum number of items to return in the results. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. - name: filter | type: object | description: Filter object. Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#filters). - name: sort | type: array | description: Sort object. Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#sorting). - name: fieldName | type: string | description: Name of the field to sort by. - name: order | type: SortOrder | description: Sort order. - enum: ASC, DESC Return type: PROMISE - name: badgeAssignments | type: array | description: List of badge assignments matching the query criteria. - name: _id | type: string | description: Badge assignment GUID. - name: badgeId | type: string | description: GUID of the badge being assigned to the member. Call the [Badges API](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/badges-v4/introduction.md) to retrieve available badges. - name: memberId | type: string | description: GUID of the member receiving the badge assignment. Call the [Members API](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/members/introduction.md) to retrieve member information. - name: _createdDate | type: Date | description: Date and time the badge assignment was created. - name: _updatedDate | type: Date | description: Date and time the badge assignment was updated. - name: tags | type: Tags | description: Tags allow you to classify ticket reservations. Learn more about [tags](https://dev.wix.com/docs/rest/business-management/tags/introduction.md). - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors. - name: tagIds | type: array | description: List of tag GUIDs - name: tags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. - name: extendedFields | type: ExtendedFields | description: Extended fields allow you to add custom properties beyond the standard reservation data. Learn more about [extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md). - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: pagingMetadata | type: CursorPagingMetadata | description: Paging metadata including cursors for pagination. - name: count | type: integer | description: Number of items returned in the response. - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. ``` ### Examples ### queryBadgeAssignments ```javascript import { badgeAssignments } from '@wix/members'; async function queryBadgeAssignments(query) { const response = await badgeAssignments.queryBadgeAssignments(query); }; ``` ### queryBadgeAssignments (with elevated permissions) ```javascript import { badgeAssignments } from '@wix/members'; import { auth } from '@wix/essentials'; async function myQueryBadgeAssignmentsMethod(query) { const elevatedQueryBadgeAssignments = auth.elevate(badgeAssignments.queryBadgeAssignments); const response = await elevatedQueryBadgeAssignments(query); } ``` ### queryBadgeAssignments (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 { badgeAssignments } from '@wix/members'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { badgeAssignments }, // Include the auth strategy and host as relevant }); async function queryBadgeAssignments(query) { const response = await myWixClient.badgeAssignments.queryBadgeAssignments(query); }; ``` ---