Organization

Get an Organization

GET
Retrieve information about a specific Organization.

Path parameters

organizationIdstringRequired
The Organization's ID.

Query parameters

isLookUpOnlybooleanOptional
Whether to show only Organization metadata.

Response

This endpoint returns an object
createdAt
datetime

The time when the Organization was created in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

createdBy
object
id
string
The Organization's ID.
isScimEnabled
boolean
Whether SCIM is enabled for the Organization.
name
string
The Organization's name.
supportPlan
enum
The Organization's support plan.
Allowed values: TRIALBASICSTANDARDPREMIUMBUSINESS_CRITICAL
updatedAt
datetime

The time when the Organization was last updated in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

updatedBy
object
billingEmail
stringOptional
The Organization's billing email.
managedDomains
list of objectsOptional
The list of managed domains configured in the Organization.
paymentMethod
enumOptional
The Organization's payment method.
Allowed values: CREDIT_CARDINVOICEAWS_MARKETPLACEAZURE_MARKETPLACEGCP_MARKETPLACE
product
enumOptional
The Organization's product type.
Allowed values: HOSTEDHYBRID
status
enumOptional
The Organization's status.
Allowed values: ACTIVEINACTIVESUSPENDED
trialExpiresAt
datetimeOptional

The time when the Organization’s trial expires in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ. Organizations that are no longer in Trial will not have a expiry date.

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