Use the GET {{baseurl}}/api/v1/groups request to retrieve a list of groups. Set the optional query parameters to filter and paginate the list. For example, to retrieve the first five groups with ‘admin’ in their name, you would call {{baseurl}}/api/v1/groups?filterByDisplayNameOrName=admin&numberPerPage=5&page=0.

Query parameters

Parameter Value Description
filterByDisplayNameOrName string This filter returns a list of groups that are a case-insensitive partial match to the display name or name specified. Additional pattern-based matching is not supported.
numberPerPage integer Number of results per page to return.
page integer Zero-based page number to retrieve.