List user group members

Request

This endpoint provides a list of members in a user group with filtering, sorting, and pagination support.

Security

Bearer

Path

companyIdstring, (uuid)required

Company ID of the user group.

Example:1234a66b-7493-4f41-908c-58ba81093653

groupIdstring, (uuid)required

Identifier for the user group.

Example:4974a66b-7493-4f41-908c-58ba81093947

Bodyapplication/jsonrequired

paginationobject(OffsetBasedPaginationRequestParams)required

Pagination information for request.

sortParamsobject(UserGroupMemberSortParams)

Sorting related parameters.

filtersArray of objects(ListUserGroupMemberFilter)

List of filters. Members matching with any filter would be returned.

curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v3/companies/1234a66b-7493-4f41-908c-58ba81093653/user-groups/4974a66b-7493-4f41-908c-58ba81093947/members \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "pagination": {
      "offset": 0,
      "limit": 100
    },
    "sortParams": {
      "sortBy": "ADDED_AT",
      "sortOrder": "DESC"
    },
    "filters": [
      {
        "addedAfter": {
          "iso8601": "2017-07-21T17:32Z"
        },
        "addedBefore": {
          "iso8601": "2017-07-21T17:32Z"
        },
        "userIds": [
          "1234a66b-7493-4f41-908c-58ba81093947"
        ]
      }
    ]
  }'

Responses

OK

Bodyapplication/json

membersArray of objects(UserGroupMember)required

List of user group members with their details.

paginationobject(PaginationResponseParams)required

Pagination information for response.

Response

{
  "members": [
    { … }
  ],
  "pagination": {
    "totalNumResults": 0
  }
}