List all orgs

GET /orgs

cURL

cURL

curl --request GET \
  --url https://api.axiom.co/v2/orgs \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.axiom.co/v2/orgs"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.axiom.co/v2/orgs', 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.axiom.co/v2/orgs",
  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.axiom.co/v2/orgs"

	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.axiom.co/v2/orgs")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.axiom.co/v2/orgs")

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

200

[
  {
    "id": "<string>",
    "lastUsageSync": "<string>",
    "license": {
      "apiRateLimitPerSecond": 123,
      "billingPeriodEnd": "2023-11-07T05:31:56Z",
      "billingPeriodStart": "2023-11-07T05:31:56Z",
      "defaultRegion": "<string>",
      "features": {},
      "id": "<string>",
      "issuedAt": "2023-11-07T05:31:56Z",
      "issuedTo": "<string>",
      "issuer": "<string>",
      "maxAuditWindowSeconds": 123,
      "maxDatasets": 123,
      "maxEndpoints": 123,
      "maxFields": 123,
      "maxMonitors": 123,
      "maxQueryWindowSeconds": 123,
      "maxUsers": 123,
      "monthlyIngestGb": 123,
      "monthlyQueryGbHours": 123,
      "regions": [
        "<string>"
      ],
      "validFrom": "2023-11-07T05:31:56Z",
      "withAuths": [
        "<string>"
      ],
      "expiresAt": "2023-11-07T05:31:56Z",
      "storageAllowanceGB": 123
    },
    "name": "<string>",
    "planCreated": "<string>",
    "primaryEmail": "<string>",
    "defaultRegion": "<string>",
    "firstFailedPayment": "<string>",
    "metaCreated": "<string>",
    "metaModified": "<string>",
    "metaVersion": "<string>",
    "role": "<string>"
  }
]

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Response

200 - application/json

Org

id · string · required

lastUsageSync · string · required

license · object · required

Show child attributes

name · string · required

paymentStatus · enum<string> · required

Available options: na, failed, success, blocked

plan · enum<string> · required

Available options: personal, basicDirect, teamMonthlyDirect, teamMonthlyAws, axiomCloud, teamPlus, enterprise, comped

planCreated · string · required

primaryEmail · string · required

defaultRegion · string

firstFailedPayment · string

metaCreated · string

metaModified · string

metaVersion · string

role · string