List Organizations

GET

https://api.astronomer.io/platform/v1beta1/organizations

GET

/platform/v1beta1/organizations

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

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

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

List Organizations

GET

https://api.astronomer.io/platform/v1beta1/organizations

GET

/platform/v1beta1/organizations

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

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

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

Authentication

AuthorizationBearer

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.

limitintegerOptional0-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.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

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

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