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.

PropertyTypeDescription
descriptionstringThe description of that group.
idlongThe Id of that group.
namestringThe name of that group.
userCountNullable integerThe 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.

Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!