API Reference

Get Organizations

get
https://{dc-region}.zuperpro.com/api/organization
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32
Defaults to 1

Page number to fetch

int32
Defaults to 10

Number of organizations in the page

string
enum
Defaults to DESC

Sort order

Allowed:
string
enum
Defaults to created_at

Sort type

Allowed:
string

Keyword search based on organization name and email

boolean

Filter by active organizations

filter.teams
array of strings

Filter by organization teams UIDs

filter.teams
date

Filter by organization updated date from

date

Filter by organization updated date to

boolean

Filter by portal enabled organizations

string

Filter by organization's custom field

string

Filter by organization uid

boolean

Filter by deleted organizations

Responses

Updated 10 months ago

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

Updated 10 months ago