List user groups for company

Request

This endpoint provides list of user groups of a company, with filtering, sorting, and pagination support.

Security

Bearer

Path

companyIdstring, (uuid)required

Identifier of the company.

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

Bodyapplication/jsonrequired

searchTextstring

Query text to search user groups. The match would be case-insensitive.

Example:"Company Admins"

paginationobject(OffsetBasedPaginationRequestParams)required

Pagination information for request.

sortParamsobject(UserGroupSortParams)

Sorting related parameters.

filtersArray of objects(ListUserGroupFilter)

List of filters. User groups matching with any filter would be returned.

curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v3/companies/1234a66b-7493-4f41-908c-58ba81093947/user-groups/list \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "searchText": "Company Admins",
    "pagination": {
      "offset": 0,
      "limit": 100
    },
    "sortParams": {
      "sortBy": "NAME",
      "sortOrder": "DESC"
    },
    "filters": [
      {
        "userGroupIds": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
        "permissions": [
          {
            "permission": "COMPANY_MANAGEMENT",
            "actions": [
              "READ"
            ]
          }
        ]
      }
    ]
  }'

Responses

OK

Bodyapplication/json

userGroupsArray of objects(RoleUserGroup)required

User groups matching with the request.

paginationobject(PaginationResponseParams)required

Pagination information for response.

Response

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