POST

Search Team

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves all team members of the requesting account, based on the provided filters and free text queries.

Important: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.

Endpoint
POST
https://www.wixapis.com/roles-management/v3/team/search
Body Params
querystring

Free text to search for within team member name and email address fields.

orderByArray <Ordering>

Sort data.

filterstruct

Filter object. Supported values: inviteType and roleId. For example, {'inviteType': {'$eq': 'Expired'}}. See API Query Language for more information.

facetsArray <string>

A list of facets to return in the response. Facets count the items within logical groupings. See Filters and Facets: An Explainer for more information.

pagingPaging

Pagination.

Response Object
facetsArray <Facet>

List of facets, as requested.

teamMembersArray <TeamMemberV3>

Existing team members and invites sent to join the account.

Search for team members by filters
Request
cURL
curl -X POST \
'https://www.wixapis.com/roles-management/v3/team/search' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>' \
-d '{
        "filter": {
          "roleId": "6600344420111308827"
        }
      }'
Response
JSON
{
    "teamMembers": [
      {
        "user": {
          "id": "fed9597b-7e80-ba1b-b666-add246249e70",
          "email": "test@email.com",
          "name": {
            "firstName": "Foo",
            "lastName": "Bar"
          },
          "joinedTeamAt": "2017-01-23T10:13:42Z",
          "assignments": [
            {
              "policyId": "6600344420111308827",
              "assignmentId": "7167886595789334551",
              "subject": {
                "id": "fed9597b-7e80-ba1b-b666-add246249e70",
                "subjectType": "USER"
              }
            },
            {
              "policyId": "6600343671872641041",
              "assignmentId": "6684420183164737859",
              "restrictions": {
                "site": {
                  "id": "867496aa-40bc-4aff-b2fc-7a5e88fbe06c",
                  "value": "xfgdfgd"
                }
              },
              "subject": {
                "id": "fed9597b-7e80-ba1b-b666-add246249e70",
                "subjectType": "USER"
              }
            }
          ]
        }
      },
      {
        "invite": {
          "id": "bfb00082-28bd-4da9-b234-9c60e6b821ed",
          "email": "some@email.com",
          "acceptLink": "https://manage.wix.com/team/accept?inviteToken=JWS.eyJraWQiOiJyLUoxaGtociIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiaW52aXRlSWRcIjpcImJmYjAwMDgyLTI4YmQtNGRhOS1iMjM0LTljNjBlNmI4MjFlZFwiLFwicmVzb3VyY2VJZFwiOlwiZmVkOTU5N2ItM2Q5Zi00Y2MyLWI5MTMtYWZmMmVjMjQ5ZTdhXCJ9IiwiaWF0IjoxNzMxMzI3MzE5fQ.A9zoljQOdoLeEsKizf1vPAeLhrJ7Mte2ZCZd-h4QGh4",
          "dateCreated": "2024-11-11T12:15:18Z",
          "dateUpdated": "2024-11-11T12:15:18Z",
          "assignments": [
            {
              "policyId": "6600344420111308827"
            }
          ],
          "expirationDate": "2024-12-11T10:15:18Z"
        }
      }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?