List Groups

GET https://{{axpAPIDomain}}/api/admin/group/v1/accounts/:accountId/groups?pageNumber=30&pageSize=5

This API requires the Account Administrator role.

Lists the groups for an account.

Request Params

The supported field that you can filter on are:

• name
• organizationNodeId
• membershipType

The allowed format:

• Begins with the column name to be filtered, followed by a colon, (This will be used as Contains operator.) then:
  • Either an exact string to match, or
  • A string expression including the * wildcard character.
    • :{PREFIX}* will be used to find out word start with.
    • :*{POSTFIX} will be used to find out word end with
    • : will be used to match exact word
• Begin with column name to be filtered, followed by a = operator. (this will be used to match exact string) | | orderBy | string | | Field name on which sorting needs to be performed.

The possible fields you ordered on are:

• name

Field Names are case-sensitive (should be written as it is in description).

The default sorting order is ascending.

To specify descending order, a suffix " desc" should be added. For example, "name" for ascending or "name desc" for descending". |

HEADERS

RESPONSES

status: OK

{"pagination":{"pageNumber":1,"pageSize":10,"total":5},"groups":[{"name":"AgentGroup","groupId":"cd79f1f0-9e35-470c-bf70-542a39882b2d","description":"Group user","resources":[{"type":"User","resourceIds":["673dab47-5a08-4593-be5a-cdc4d23df814"]}],"organizationNodeId":"QTRWAD"}],"links":[{"prev":"/api/admin/group/v1/accounts/ASDJGE/groups?pageNumber=1\u0026pageSize=10","next":"/api/admin/group/v1/accounts/ASDJGE/groups?pageNumber=3\u0026pageSize=10"}]}