Retrieve a list of groups

Retrieve a list of groups in an organization.

SecuritybearerAuth

Request

query Parameters

limit	integer Number of records to return. Example: limit=100
offset	integer Record to start with. Example: offset=0
groupIds	string IDs of groups to return.
includeSubgroups	boolean If true, all subgroups under the specified group are included. Example: includeSubgroups=false
sort	string Name of the property to sort on. Example: sort=Description
order	string Sort direction. Example: order=asc

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/groups

Request samples

curl
JavaScript
Node.js

Response samples

application/json

{"groups": [{"id": "880e60d8-fbed-217a-1720-6511d9f16361",
"createdDate": "0001-01-01T00:00:00",
"description": "Description here",
"fullPath": "Test Root Group\\Test Parent Group\\Test Group Name",
"fullPathId": "880e60d8-fbed-217b-1720-6511d9f16361\\880e60d8-fbed-217b-1720-6511d9f16361\\880e60d8-fbed-217a-1720-6511d9f16361",
"name": "Test Group Name",
"parentId": "880e60d8-fbed-217b-1720-6511d9f16361",
"revision": 0,
"rootGroupId": "880e60d8-fbed-217c-1720-6511d9f16361",
"updatedDate": "0001-01-01T00:00:00"
},
{"id": "880e60d8-fbed-217b-1720-6511d9f16361",
"createdDate": "0001-01-01T00:00:00",
"description": "Description here",
"fullPath": "Test Root Group\\Test Parent Group",
"fullPathId": "880e60d8-fbed-217b-1720-6511d9f16361\\880e60d8-fbed-217b-1720-6511d9f16361",
"name": "Test Parent Group",
"parentId": "880e60d8-fbed-217b-1720-6511d9f16361",
"revision": 1,
"rootGroupId": "880e60d8-fbed-217c-1720-6511d9f16361",
"updatedDate": "0001-01-01T00:00:00"
}
],
"metadata": {"count": 102,
"limit": 100,
"offset": 2
}
}