> 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 # QueryUserMembers # Package: memberManagement # Namespace: UserMembers # Method link: https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/user-member/query-user-members.md ## Permission Scopes: SCOPE.DC-MEMBERS.READ-USER-MEMBERS: SCOPE.DC-MEMBERS.READ-USER-MEMBERS ## Introduction Retrieves a list of user members, given the provided paging, filtering, and sorting. Query User Members runs with these defaults, which you can override: - `createdDate` is sorted in `ASC` order - `paging.limit` is `100` - `paging.offset` is `0` To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md), [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging.md), and [Field Projection](https://dev.wix.com/docs/rest/articles/getting-started/field-projection.md). >**Note:** >This method requires [visitor or member authentication](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities.md). --- ## REST API ### Schema ``` Method: queryUserMembers Description: Retrieves a list of user members, given the provided paging, filtering, and sorting. Query User Members runs with these defaults, which you can override: - `createdDate` is sorted in `ASC` order - `paging.limit` is `100` - `paging.offset` is `0` To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md), [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging.md), and [Field Projection](https://dev.wix.com/docs/rest/articles/getting-started/field-projection.md). >**Note:** >This method requires [visitor or member authentication](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities.md). URL: https://www.wixapis.com/members/v1/user-members/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: Number of items to load. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. You can get 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 in the following format: `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }` Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` - name: sort | type: array | description: Sort object in the following format: `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` - name: fieldName | type: string | description: Name of the field to sort by. - name: order | type: SortOrder | description: Sort order. - enum: - ASC: Sorting is in ascending order. - DESC: Sorting is in descending order. Return type: QueryUserMembersResponse - name: userMembers | type: array | description: Retrieved user members. - name: memberId | type: string | description: Profile GUID. - name: userId | type: string | description: User GUID. - name: contactId | type: string | description: Contact GUID. - name: siteMembersInstanceId | type: string | description: Instance GUID of the installed [Wix Members Area app](https://www.wix.com/app-market/web-solution/members-area) on the Wix site. - name: metaSiteId | type: string | description: Metasite GUID. - name: photo | type: Image | description: User member profile picture. - name: id | type: string | description: Wix Media image GUID, set when the member selects an image from Wix Media. - name: url | type: string | description: Image URL. - name: height | type: integer | description: Original image width. - name: width | type: integer | description: Original image height. - name: offsetX | type: integer | description: X-axis offset. Default: `0`. - name: offsetY | type: integer | description: Y-axis offset. Default: `0`. - name: nickname | type: string | description: User member nickname. - name: privacyStatus | type: Status | description: User member profile privacy status. - enum: - UNKNOWN: Unknown status. This value isn't used. - PRIVATE: User member is hidden from everyone who visits the site. The member is returned only to Wix users and apps with the appropriate permissions. - PUBLIC: User member is visible to everyone. - name: createdDate | type: string | description: Date and time the user member was created. - name: updatedDate | type: string | description: Date and time the user member was updated. - name: status | type: Status | description: User member site access status. - enum: - UNKNOWN: Unknown status. This value isn't used. - PENDING: User member is created and is waiting for the approval. - APPROVED: User member is approved and can log in to the site. - BLOCKED: User member is approved and can't log in to the site. - OFFLINE: User member is a [guest author](https://support.wix.com/en/article/wix-blog-adding-managed-writers-to-your-blog) for the site blog and can't log in to the site. - name: activityStatus | type: Status | description: User member activity status. - enum: - UNKNOWN: Unknown status. This value isn't used. - ACTIVE: User member can participate in site activities, such as writing blog posts and forum comments. - MUTED: User member can't participate in site activities, such as writing blog posts and forum comments. - name: metadata | type: CursorPagingMetadata | description: Metadata for the paginated results. - name: count | type: integer | description: Number of items returned in current page. - 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. ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.memberManagement.UserMembers.queryUserMembers(query) Description: Retrieves a list of user members, given the provided paging, filtering, and sorting. Query User Members runs with these defaults, which you can override: - `createdDate` is sorted in `ASC` order - `paging.limit` is `100` - `paging.offset` is `0` To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md), [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging.md), and [Field Projection](https://dev.wix.com/docs/rest/articles/getting-started/field-projection.md). >**Note:** >This method requires [visitor or member authentication](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities.md). # 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: UserMemberQuery | 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: Number of items to load. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. You can get 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 in the following format: `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }` Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` - name: sort | type: array | description: Sort object in the following format: `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` - name: fieldName | type: string | description: Name of the field to sort by. - name: order | type: SortOrder | description: Sort order. - enum: - ASC: Sorting is in ascending order. - DESC: Sorting is in descending order. Return type: PROMISE - name: userMembers | type: array | description: Retrieved user members. - name: memberId | type: string | description: Profile GUID. - name: userId | type: string | description: User GUID. - name: contactId | type: string | description: Contact GUID. - name: siteMembersInstanceId | type: string | description: Instance GUID of the installed [Wix Members Area app](https://www.wix.com/app-market/web-solution/members-area) on the Wix site. - name: metaSiteId | type: string | description: Metasite GUID. - name: photo | type: Image | description: User member profile picture. - name: _id | type: string | description: Wix Media image GUID, set when the member selects an image from Wix Media. - name: url | type: string | description: Image URL. - name: height | type: integer | description: Original image width. - name: width | type: integer | description: Original image height. - name: offsetX | type: integer | description: X-axis offset. Default: `0`. - name: offsetY | type: integer | description: Y-axis offset. Default: `0`. - name: nickname | type: string | description: User member nickname. - name: privacyStatus | type: Status | description: User member profile privacy status. - enum: - UNKNOWN: Unknown status. This value isn't used. - PRIVATE: User member is hidden from everyone who visits the site. The member is returned only to Wix users and apps with the appropriate permissions. - PUBLIC: User member is visible to everyone. - name: _createdDate | type: Date | description: Date and time the user member was created. - name: _updatedDate | type: Date | description: Date and time the user member was updated. - name: status | type: Status | description: User member site access status. - enum: - UNKNOWN: Unknown status. This value isn't used. - PENDING: User member is created and is waiting for the approval. - APPROVED: User member is approved and can log in to the site. - BLOCKED: User member is approved and can't log in to the site. - OFFLINE: User member is a [guest author](https://support.wix.com/en/article/wix-blog-adding-managed-writers-to-your-blog) for the site blog and can't log in to the site. - name: activityStatus | type: Status | description: User member activity status. - enum: - UNKNOWN: Unknown status. This value isn't used. - ACTIVE: User member can participate in site activities, such as writing blog posts and forum comments. - MUTED: User member can't participate in site activities, such as writing blog posts and forum comments. - name: metadata | type: CursorPagingMetadata | description: Metadata for the paginated results. - name: count | type: integer | description: Number of items returned in current page. - 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 ### queryUserMembers ```javascript import { userMember } from '@wix/members'; async function queryUserMembers(query) { const response = await userMember.queryUserMembers(query); }; ``` ### queryUserMembers (with elevated permissions) ```javascript import { userMember } from '@wix/members'; import { auth } from '@wix/essentials'; async function myQueryUserMembersMethod(query) { const elevatedQueryUserMembers = auth.elevate(userMember.queryUserMembers); const response = await elevatedQueryUserMembers(query); } ``` ### queryUserMembers (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 { userMember } from '@wix/members'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { userMember }, // Include the auth strategy and host as relevant }); async function queryUserMembers(query) { const response = await myWixClient.userMember.queryUserMembers(query); }; ``` ---