Get all organizations

  • 1 minute(s) read
Prev Next
Get
/v2/network/organizations

Returns the list of all organizations.
This endpoint is authorized to organizations only, and allows retrieving the list of organizations specifying:
 - The sorting criteria (also multiple).
 - The paging configuration.

The list of results is limited to only those organizations authorized to the user's parent organization.
Required permissions: READ_ALL_ORGANIZATIONS.

Security
HTTP
Type bearer
Header parameters
X-Servitly-Tenant
stringRequired

The name of the target tenant (e.g. acme).

Query parameters
size
integer

The number of elements to retrieve for the current page.

Minimum1.0
Example200
page
integer

The page number to retrieve (zero-based).

Minimum0.0
Example0
sort
string

The sorting criteria based on object properties.

Minimum0.0
Examplename,ASC
Responses
200

Successful operation.

Expand All
object
content
Array of object (Organization)
object
id
string
name
string
country
string
timezone
string
parent
object
id
string
Example1234abcd
first
boolean
last
boolean
totalPages
integer
totalElements
integer
sort
string
numberOfElements
integer
size
integer
number
integer
Minimum0.0
401

User not authenticated.

object
message
string

The error response.

ExampleUser not authenticated
403

User not authorized.

object
message
string

The error response.

ExampleUser not authorized
404

Resource was not found.

object
message
string

The error response.

ExampleResource not found
429

API call rate limit exeeded.

object
message
string

The error response.

ExampleAPI call rate limit exeeded
500

Internal server error.

object
message
string

The error response.

ExampleInternal Server Error