UserGroupService

ListUserGroups

Retrieves user groups using an optional filter.

get/api/v2/user-groups

Request

  • Base URL: https://api.siftstack.com
  • URL: https://api.siftstack.com/api/v2/user-groups
  • Auth: HTTP bearer

Query parameters

pageSizeinteger

The maximum number of user groups to return. The service may return fewer than this value. If unspecified, at most 50 will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageTokenstring

A page token, received from a previous ListUserGroups call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListUserGroups must match the call that provided the page token.

filterstring

A Common Expression Language (CEL, https://github.com/google/cel-spec) filter string. Available tag variables are:

  • name
orderBystring

How to order the retrieved user groups. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available fields to order_by are name, created_date, and modified_date. If left empty, items are ordered by name in ascending order (A-Z). For more information about the format of this field, read this Example: "created_date desc,modified_date"

Response

A successful response.

nextPageTokenstring

A token, which can be sent as page_token to retrieve the next page. If this field is empty, there are no subsequent pages.

Changes

No recorded changes to this operation across all 1 revision of this API.