Skip to main content

List a page of groups

POST 
/api/web/v1/groupspaged

Returns groups for the provided search parameters. Caller requires the GROUPS:VIEW permission. The following searchByAttributes are supported:

  • name: a string value that indicates the name of the group. Allowed operators are: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, STARTS_WITH, ENDS_WITH.
  • type: a string with the value that indicates the type of the group. Allowed operator: EQUALS.
If you provide more than one search attribute, they are joined with an AND condition.

The orderByAttribute supports this attribute name: name.

Request​

Responses​

Successful