Organization

List Organizations

GET
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: TRIALBASICSTANDARDPREMIUMBUSINESS_CRITICAL
productenumOptional
Filters the Organization list by product.
Allowed values: HOSTEDHYBRID
offsetintegerOptional
The number of results to skip before returning values.
limitintegerOptional
The maximum number of results to return.
sortsenumOptional

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

This endpoint returns an object
limit
integer
The maximum number of Organizations in the page.
offset
integer
The offset of the Organizations in the page.
organizations
list of objects
The list of Organizations in the page.
totalCount
integer
The total number of Organizations.
GET
1curl https://api.astronomer.io/platform/v1beta1/organizations \
2     -H "Authorization: Bearer <token>"
Response
1{
2  "limit": 10,
3  "offset": 0,
4  "organizations": [
5    {
6      "createdAt": "2022-11-22T04:37:12Z",
7      "createdBy": {
8        "id": "clm8qv74h000008mlf08scq7k",
9        "apiTokenName": "my-token",
10        "avatarUrl": "https://avatar.url",
11        "fullName": "Jane Doe",
12        "username": "user1@company.com"
13      },
14      "id": "clmaxoarx000008l2c5ayb9pt",
15      "isScimEnabled": false,
16      "name": "My organization",
17      "supportPlan": "TRIAL",
18      "updatedAt": "2022-11-22T04:37:12Z",
19      "updatedBy": {
20        "id": "clm8qv74h000008mlf08scq7k",
21        "apiTokenName": "my-token",
22        "avatarUrl": "https://avatar.url",
23        "fullName": "Jane Doe",
24        "username": "user1@company.com"
25      },
26      "billingEmail": "billing@company.com",
27      "managedDomains": [
28        {
29          "createdAt": "2024-01-15T09:30:00Z",
30          "id": "cln203mz7000008jv0jyz9m3y",
31          "name": "mycompany.com",
32          "organizationId": "cln204xr2000008mu3hhe3zwe",
33          "status": "PENDING",
34          "updatedAt": "2024-01-15T09:30:00Z"
35        }
36      ],
37      "paymentMethod": "CREDIT_CARD",
38      "product": "HOSTED",
39      "status": "ACTIVE",
40      "trialExpiresAt": "2022-11-22T04:37:12Z"
41    }
42  ],
43  "totalCount": 100
44}
Built with