List all groups

Retrieve a paginated list of groups for the authenticated tenant.

SecurityAPIKeyHeader

Request

query Parameters

external_id	string External ID to filter by. Can be specified multiple times for multiple IDs.
page	integer A page number within the paginated result set.

Responses

200

Response Schema: application/json

count	integer
	Array of objects (Group)
next	string or null <uri>
previous	string or null <uri>

get/groups/

Request samples

curl
Node.js
JavaScript
Python
Java

Response samples

application/json

{"count": 123,
"data": [{"created_at": "2019-08-24T14:15:22Z",
"created_by_user_id": "string",
"description": "string",
"external_id": "string",
"id": "string",
"name": "string",
"parent": "string",
"status": "ACTIVE",
"updated_at": "2019-08-24T14:15:22Z",
"updated_by_user_id": "string"
}
],
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2"
}