curl --request GET \
--url https://api.astronomer.io/v1/organizations \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.astronomer.io/v1/organizations"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.astronomer.io/v1/organizations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.astronomer.io/v1/organizations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.astronomer.io/v1/organizations"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.astronomer.io/v1/organizations")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.astronomer.io/v1/organizations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"limit": 10,
"offset": 0,
"organizations": [
{
"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"
},
"hasAllowedIpAddressRanges": false,
"id": "clmaxoarx000008l2c5ayb9pt",
"isBlockedEnableAiFeatures": false,
"isScimEnabled": false,
"name": "My organization",
"productPlans": [
{
"astronomerProduct": "ASTRO",
"organizationId": "<string>",
"productPlanId": "<string>",
"productPlanName": "BUSINESS_CRITICAL"
}
],
"shouldEnforceDedicatedClusters": true,
"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",
"hasAiFeaturesDisabled": true,
"managedDomains": [
{
"createdAt": "2023-11-07T05:31:56Z",
"id": "cln203mz7000008jv0jyz9m3y",
"name": "mycompany.com",
"organizationId": "cln204xr2000008mu3hhe3zwe",
"updatedAt": "2023-11-07T05:31:56Z",
"enforcedLogins": [
"password"
]
}
],
"paymentMethod": "CREDIT_CARD",
"product": "HOSTED",
"status": "ACTIVE",
"trialExpiresAt": "2022-11-22T04:37:12Z"
}
],
"totalCount": 100
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}List Organizations
List the details about all Organizations that you have access to. Requires using a personal access token (PAT) for authentication.
curl --request GET \
--url https://api.astronomer.io/v1/organizations \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.astronomer.io/v1/organizations"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.astronomer.io/v1/organizations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.astronomer.io/v1/organizations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.astronomer.io/v1/organizations"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.astronomer.io/v1/organizations")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.astronomer.io/v1/organizations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"limit": 10,
"offset": 0,
"organizations": [
{
"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"
},
"hasAllowedIpAddressRanges": false,
"id": "clmaxoarx000008l2c5ayb9pt",
"isBlockedEnableAiFeatures": false,
"isScimEnabled": false,
"name": "My organization",
"productPlans": [
{
"astronomerProduct": "ASTRO",
"organizationId": "<string>",
"productPlanId": "<string>",
"productPlanName": "BUSINESS_CRITICAL"
}
],
"shouldEnforceDedicatedClusters": true,
"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",
"hasAiFeaturesDisabled": true,
"managedDomains": [
{
"createdAt": "2023-11-07T05:31:56Z",
"id": "cln203mz7000008jv0jyz9m3y",
"name": "mycompany.com",
"organizationId": "cln204xr2000008mu3hhe3zwe",
"updatedAt": "2023-11-07T05:31:56Z",
"enforcedLogins": [
"password"
]
}
],
"paymentMethod": "CREDIT_CARD",
"product": "HOSTED",
"status": "ACTIVE",
"trialExpiresAt": "2022-11-22T04:37:12Z"
}
],
"totalCount": 100
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Filters the Organization list by product plan.
TRIAL, BASIC, STANDARD, PREMIUM, BUSINESS_CRITICAL filter by astronomer product, should be one of ASTRO
ASTRO Filters the Organization list by product.
HOSTED, HYBRID The number of results to skip before returning values.
x >= 0The maximum number of results to return.
0 <= x <= 1000A list of field names to sort by, and whether to show results as ascending or descending. Formatted as <fieldName>:asc or <fieldName>:desc.
name:asc, name:desc, createdAt:asc, createdAt:desc, updatedAt:asc, updatedAt:desc Response
OK
The maximum number of Organizations in the page.
10
The offset of the Organizations in the page.
0
The list of Organizations in the page.
Show child attributes
Show child attributes
The total number of Organizations.
100
Was this page helpful?