Groups

List groups

get
Authorizations
X-Api-KeystringRequired

HIVO API Key

X-User-IdstringRequired

HIVO User ID

Query parameters
sortstring · enumOptional

Sort key. Allowed values are name, -name, createdAt, -createdAt, lastModified, -lastModified. Defaults to name.

Default: namePossible values:
limitinteger · min: 1 · max: 256Optional

Maximum number of groups to return (1-256). Defaults to 32.

Default: 32
skipinteger · max: 65536Optional

Number of groups to skip (pagination) (0-65536). Defaults to 0.

Default: 0
filter[id]string[]Optional

Group ID filter. May be repeated and/or provided as a comma-separated list. Max 512 IDs.

filter[search]string · max: 256Optional

General search string (max 256 chars). Searches group name (case-insensitive).

Responses
chevron-right
200

OK

application/json
metaobjectRequired
get
/v1/groups

Get group

get
Authorizations
X-Api-KeystringRequired

HIVO API Key

X-User-IdstringRequired

HIVO User ID

Path parameters
groupIdstringRequired

Group ID

Responses
chevron-right
200

OK

application/json
metaobjectOptional
get
/v1/groups/{groupId}

Last updated