GET Groups
Overview
The Group List endpoint provides an entry point to all of the data available via the API. Other endpoints require one or more object identifiers (e.g. a group UUID), but this one does not have any prerequisites. The Group List response includes all groups accessible by the given API credentials.
Query parameters
limit |
|
offset |
|
sortBy |
See Paging parameters |
sortDirection |
Curl example
curl -X GET \
'https://API_HOSTNAME/api/v1/groups?offset=10&limit=10' \
--header 'Authorization: Bearer BEARER_TOKEN'Response
The response is a list of groups, with additional fields that contain paging metadata and links to the previous and next pages, if they exist.
Response body
{
"totalCount": 38,
"limit": 10,
"offset": 10,
"results":[
{
"href": "/api/v1/groups/PARENT_GROUP_UUID",
"uuid": "PARENT_GROUP_UUID",
"name": "Parent Group Name"
},
{
"href": "/api/v1/groups/GROUP_UUID",
"uuid": "GROUP_UUID",
"name": "Child Group One",
"parent": {
"href": "/api/v1/groups/PARENT_GROUP_UUID",
"title": "Parent Group Name"
}
},
…
],
"nextPage": "https://API_HOSTNAME/api/v1/groups?offset=20&limit=10",
"previousPage": "https://API_HOSTNAME/api/v1/groups?offset=0&limit=10"
}