Page tree
Skip to end of metadata
Go to start of metadata

You can get the list of groups with the getGroups method.

Permission to run the request: Account Owner, Administrator, Organization Administrator, Publisher. 

 

Parameters

ParameterTypeDescription
credentials (required)credentialsRead the description of the Credentials object.
organizationId (optional)intList of groups in the specified organization.

Organization Administrators can get the list of groups only within their own organization.

If the specified organization is not found, you will get the list of all groups in the response. As for Publishers and Organization Administrators, they will get the list of groups within their own organization in this case.

 

Return Value

After the request has been completed, the system returns an object with the following properties:

ParameterTypeDescription
groupsgroup[]An array of groups. The Group object has the same properties as in the getGroupInformation method.

 

Sample Call

Sample Response

  •