Skip to main content

List a page of organizations

POST 
/api/web/v1/organizationspaged

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

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

The orderByAttribute supports these attribute names: displayName, name.

Request​

Responses​

Successful