Sign in
Groups

Gets information about groups associated with the account.

Gets information about groups associated with the account.

<ds-inlinemessage kind="information" markdown="1"> To get the users in a group:
  1. Use this endpoint to get the group ID.
  2. Use listGroupUsers to get the list of users. </ds-inlinemessage>

Related topics

  • How to set a permission profile
get/v2.1/accounts/{accountId}/groups

Path parameters

accountIdstring required

The external account number (int) or account ID GUID.

Query parameters

countstring

The maximum number of results to return.

Use start_position to specify the number of results to skip.

Valid values: 1 to 100

group_typestring

The type of group to return. Valid values:

  • AdminGroup
  • CustomGroup
  • EveryoneGroup
include_usercountstring

When true, every group returned in the response includes a userCount property that contains the total number of users in the group. The default is true.

search_textstring

Filters the results of a GET request based on the text that you specify.

start_positionstring

The zero-based index of the result from which to start returning results.

Use with count to limit the number of results.

The default value is 0.

Response

Successful response.

Changes

No recorded changes to this endpoint across all 39 revisions of this API.