Sign in

v1

latestOpenAPI 3.0.02026-08-063014193.1 MB
Groups

Return the data for all Groups

Outlines the parameters, optional and required, used when requesting the data for all Groups

get/groups.json

Query parameters

archivedboolean

Filter archived Group records.

created_sincestring date-time

Filter Group records to those having the created_at field after a specific time. (Expects an ISO-8601 timestamp).

fieldsstring

The fields to be returned. See response samples for what fields are available. For more information see the fields section.

ids[]integer

Filter Group records to those having the specified unique identifiers.

limitinteger

A limit on the number of Group records to be returned. Limit can range between 1 and 200. Default: 200.

namestring

Filter Group records to those that match the given name.

order'id(asc)' | 'id(desc)' | 'name(asc)' | 'name(desc)'

Orders the Group records by the given field. Default: id(asc).

page_tokenstring

A token specifying which page to return.

querystring

Wildcard search for name matching a given string.

type'AccountGroup' | 'AdhocGroup' | 'UserGroup'

Filter Group records to those that match the given type.

updated_sincestring date-time

Filter Group records to those having the updated_at field after a specific time. (Expects an ISO-8601 timestamp).

user_idinteger

The unique identifier for a single User. The keyword null is not valid for this field. The list will be filtered to include only the Group records with the matching property.

Headers

X-API-VERSIONstring

The API minor version. Default: latest version.

Response

Ok