Get an Organization | Astronomer Documentation

{
  "allowEnhancedSupportAccess": true,
  "createdAt": "2022-11-22T04:37:12Z",
  "createdBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  },
  "id": "clmaxoarx000008l2c5ayb9pt",
  "isScimEnabled": false,
  "name": "My organization",
  "supportPlan": "INACTIVE",
  "updatedAt": "2022-11-22T04:37:12Z",
  "updatedBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  },
  "billingEmail": "billing@company.com",
  "managedDomains": [
    {
      "createdAt": "2024-01-15T09:30:00Z",
      "id": "cln203mz7000008jv0jyz9m3y",
      "name": "mycompany.com",
      "organizationId": "cln204xr2000008mu3hhe3zwe",
      "status": "PENDING",
      "updatedAt": "2024-01-15T09:30:00Z",
      "enforcedLogins": [
        "password"
      ]
    }
  ],
  "paymentMethod": "CREDIT_CARD",
  "product": "HOSTED",
  "productPlans": [
    {
      "astronomerProduct": "ASTRO",
      "organizationId": "organizationId",
      "productPlanId": "productPlanId",
      "productPlanName": "productPlanName"
    }
  ],
  "status": "ACTIVE",
  "trialExpiresAt": "2022-11-22T04:37:12Z"
}

Retrieve information about a specific Organization.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

organizationIdstringRequired

The Organization's ID.

Query parameters

isLookUpOnlybooleanOptional

Whether to show only Organization metadata.

Response

allowEnhancedSupportAccessboolean

Whether the organization allows CRE to have view access to their entities

createdAtdatetime

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

createdByobject

idstring

The Organization's ID.

isScimEnabledboolean

Whether SCIM is enabled for the Organization.

namestring

The Organization's name.

supportPlanenum

The Organization's support plan.

updatedAtdatetime

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

updatedByobject

billingEmailstringOptional

The Organization's billing email.

managedDomainslist of objectsOptional

The list of managed domains configured in the Organization.

paymentMethodenumOptional

The Organization's payment method.

productenumOptional

The Organization's product type.

productPlanslist of objectsOptional

statusenumOptional

The Organization's status.

trialExpiresAtdatetimeOptional

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.

Errors

400

Get Organization Request Bad Request Error

401

Get Organization Request Unauthorized Error

403

Get Organization Request Forbidden Error

404

Get Organization Request Not Found Error

500

Get Organization Request Internal Server Error

$	curl -G https://api.astronomer.io/platform/v1beta1/organizations/organizationId \
>	-H "Authorization: Bearer <token>" \
>	-d isLookUpOnly=true