Skip to main content
GET
List Organizations

Authorizations

Authorization
string
header
required

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

Query Parameters

productPlan
enum<string>

Filters the Organization list by product plan.

Available options:
TRIAL,
BASIC,
STANDARD,
PREMIUM,
BUSINESS_CRITICAL
astronomerProduct
enum<string>

filter by astronomer product, should be one of ASTRO

Available options:
ASTRO
product
enum<string>

Filters the Organization list by product.

Available options:
HOSTED,
HYBRID
offset
integer
default:0

The number of results to skip before returning values.

Required range: x >= 0
limit
integer
default:20

The maximum number of results to return.

Required range: 0 <= x <= 1000
sorts
enum<string>[]

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

Available options:
name:asc,
name:desc,
createdAt:asc,
createdAt:desc,
updatedAt:asc,
updatedAt:desc

Response

OK

limit
integer
required

The maximum number of Organizations in the page.

Example:

10

offset
integer
required

The offset of the Organizations in the page.

Example:

0

organizations
object[]
required

The list of Organizations in the page.

totalCount
integer
required

The total number of Organizations.

Example:

100