List Organizations

GET

https://api.astronomer.io/v1/organizations

GET

/v1/organizations

$ curl https://api.astronomer.io/v1/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       "hasAllowedIpAddressRanges": false,
17       "id": "clmaxoarx000008l2c5ayb9pt",
18       "isScimEnabled": false,
19       "name": "My organization",
20       "productPlans": [
21         {
22           "astronomerProduct": "ASTRO",
23           "organizationId": "string",
24           "productPlanId": "string",
25           "productPlanName": "BUSINESS_CRITICAL"
26         }
27       ],
28       "shouldEnforceDedicatedClusters": true,
29       "updatedAt": "2022-11-22T04:37:12Z",
30       "updatedBy": {
31         "id": "clm8qv74h000008mlf08scq7k",
32         "apiTokenName": "my-token",
33         "avatarUrl": "https://avatar.url",
34         "fullName": "Jane Doe",
35         "subjectType": "USER",
36         "username": "user1@company.com"
37       },
38       "billingEmail": "billing@company.com",
39       "managedDomains": [
40         {
41           "createdAt": "2024-01-15T09:30:00Z",
42           "id": "cln203mz7000008jv0jyz9m3y",
43           "name": "mycompany.com",
44           "organizationId": "cln204xr2000008mu3hhe3zwe",
45           "status": "PENDING",
46           "updatedAt": "2024-01-15T09:30:00Z",
47           "enforcedLogins": [
48             "password"
49           ]
50         }
51       ],
52       "paymentMethod": "CREDIT_CARD",
53       "product": "HOSTED",
54       "status": "ACTIVE",
55       "trialExpiresAt": "2022-11-22T04:37:12Z"
56     }
57   ],
58   "totalCount": 100
59 }

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

List Organizations

Authentication

Query parameters

Response

Errors

$	curl https://api.astronomer.io/v1/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	"hasAllowedIpAddressRanges": false,
17	"id": "clmaxoarx000008l2c5ayb9pt",
18	"isScimEnabled": false,
19	"name": "My organization",
20	"productPlans": [
21	{
22	"astronomerProduct": "ASTRO",
23	"organizationId": "string",
24	"productPlanId": "string",
25	"productPlanName": "BUSINESS_CRITICAL"
26	}
27	],
28	"shouldEnforceDedicatedClusters": true,
29	"updatedAt": "2022-11-22T04:37:12Z",
30	"updatedBy": {
31	"id": "clm8qv74h000008mlf08scq7k",
32	"apiTokenName": "my-token",
33	"avatarUrl": "https://avatar.url",
34	"fullName": "Jane Doe",
35	"subjectType": "USER",
36	"username": "user1@company.com"
37	},
38	"billingEmail": "billing@company.com",
39	"managedDomains": [
40	{
41	"createdAt": "2024-01-15T09:30:00Z",
42	"id": "cln203mz7000008jv0jyz9m3y",
43	"name": "mycompany.com",
44	"organizationId": "cln204xr2000008mu3hhe3zwe",
45	"status": "PENDING",
46	"updatedAt": "2024-01-15T09:30:00Z",
47	"enforcedLogins": [
48	"password"
49	]
50	}
51	],
52	"paymentMethod": "CREDIT_CARD",
53	"product": "HOSTED",
54	"status": "ACTIVE",
55	"trialExpiresAt": "2022-11-22T04:37:12Z"
56	}
57	],
58	"totalCount": 100
59	}