Platform API ReferenceOrganization

List Organizations

List the details about all Organizations that you have access to. Requires using a personal access token (PAT) for authentication.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

supportPlanenumOptional
Filters the Organization list by support plan.
Allowed values:
productPlanenumOptional
Filters the Organization list by product plan.
Allowed values:
astronomerProductenumOptional
filter by astronomer product, should be one of ASTRO or OBSERVE
Allowed values:
productenumOptional
Filters the Organization list by product.
Allowed values:
offsetintegerOptional>=0Defaults to 0
The number of results to skip before returning values.
limitintegerOptional>=0<=1000Defaults to 20
The maximum number of results to return.
sortslist of enumsOptional

A list of field names to sort by, and whether to show results as ascending or descending. Formatted as <fieldName>:asc or <fieldName>:desc.

Response

OK
limitinteger
The maximum number of Organizations in the page.
offsetinteger
The offset of the Organizations in the page.
organizationslist of objects
The list of Organizations in the page.
totalCountinteger
The total number of Organizations.

Errors