get https://api.alocity.com/v1/integration-management/groups
This endpoint is used to get all groups on the account.
Response Payload Object
The response's payload will contain an array of objects containing the following values.
Property | Type | Description |
---|---|---|
description | string | The description of that group. |
id | long | The Id of that group. |
name | string | The name of that group. |
userCount | Nullable integer | The number of users for that group. If the user count is not requested, this value will be null. |
Any fields returned in the response's payload that are not listed here are "empty" fields that should be ignored as they will always be the same value or will not be filled in.
Note that if an error was found, then the payload will be null, however if no values were found and no error occurred, then an empty list will be returned instead.
Any status codes returned that are not provided here are generic status codes that can be found here.