List Organizations

1 curl https://api.astronomer.io/platform/v1beta1/organizations \ 2 -H "Authorization: Bearer <token>"

1 { 2 "limit": 10, 3 "offset": 0, 4 "organizations": [ 5 { 6 "billingEmail": "billing@company.com", 7 "createdAt": "2022-11-22T04:37:12Z", 8 "createdBy": { 9 "apiTokenName": "my-token", 10 "avatarUrl": "https://avatar.url", 11 "fullName": "Jane Doe", 12 "id": "clm8qv74h000008mlf08scq7k", 13 "subjectType": "USER", 14 "username": "user1@company.com" 15 }, 16 "id": "clmaxoarx000008l2c5ayb9pt", 17 "isScimEnabled": false, 18 "managedDomains": [ 19 { 20 "createdAt": "createdAt", 21 "enforcedLogins": [ 22 "password" 23 ], 24 "id": "cln203mz7000008jv0jyz9m3y", 25 "name": "mycompany.com", 26 "organizationId": "cln204xr2000008mu3hhe3zwe", 27 "status": "PENDING", 28 "updatedAt": "updatedAt" 29 } 30 ], 31 "name": "My organization", 32 "paymentMethod": "CREDIT_CARD", 33 "product": "HOSTED", 34 "status": "ACTIVE", 35 "supportPlan": "BUSINESS_CRITICAL", 36 "trialExpiresAt": "2022-11-22T04:37:12Z", 37 "updatedAt": "2022-11-22T04:37:12Z", 38 "updatedBy": { 39 "apiTokenName": "my-token", 40 "avatarUrl": "https://avatar.url", 41 "fullName": "Jane Doe", 42 "id": "clm8qv74h000008mlf08scq7k", 43 "subjectType": "USER", 44 "username": "user1@company.com" 45 } 46 } 47 ], 48 "totalCount": 100 49 }

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

Query parameters

supportPlanenumOptional

Filters the Organization list by support plan.

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

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.

Headers

Query parameters

Response

Errors