List organizations

Retrieve a page of organizations with their contact details. Without archived every organization is returned; archived=false returns active ones only and archived=true archived ones only. Without a sort.property the default organization comes first, then by name. Requires the account_limited permission (403 otherwise). While multi-org is on, a caller limited to some organizations' campuses gets only those organizations, as the organization choices do.

Required permission: Limited Account

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean

If true, returns only archived organizations; if false, only active organizations. If not provided, returns every organization regardless of status.

int32
≥ 0

The number of records to skip before returning results, used for paging.

int32
≥ 0

The maximum number of records to return per page. Defaults to 50.

string

The field to sort the results by. The default field depends on the endpoint.

string
enum

The sort direction: "asc" or "desc".

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json