Organizations API

Axiom organizations API retrieves all of the organizations in your account and returns your plan details.

Request Example

GET /api/v1/orgs

curl -X 'GET' \
  'https://api.axiom.co/v1/orgs' \
  -H 'Authorization: Bearer <$PERSONAL_TOKEN>'

Response Example

Response code 200 and the response body:

[
    {
        "id": "string",
        "name": "string",
        "plan": "string",
        "planCreated": "2021-05-27T12:45:29.317262117Z",
        "lastUsageSync": "0001-01-01T00:00:00Z",
        "paymentStatus": "na",
        "firstFailedPayment": "",
        "role": "owner",
        "primaryEmail": "string",
        "license": {
            "id": "string",
            "tier": "string",
            "issuer": "string",
            "issuedTo": "string",
            "issuedAt": "2021-05-27T12:45:29.317262117Z",
            "validFrom": "2021-05-27T12:45:29.317262117Z",
            "monthlyIngestGb": 500,
            "apiRateLimitPerSecond": 10,
            "maxUsers": 3,
            "maxTeams": 0,
            "maxDatasets": 3,
            "maxMonitors": 5,
            "maxFields": 256,
            "maxEndpoints": 1,
            "maxQueryWindowSeconds": 2592000,
            "maxAuditWindowSeconds": 0,
            "withRBAC": false,
            "withAuths": [
                "\"local\"",
                "\"sso\""
            ],
            "features": {
                "endpointsDatadog": true,
                "endpointsHoneycomb": true,
                "endpointsJaeger": false,
                "endpointsLoki": true,
                "endpointsSecureSyslog": false,
                "endpointsSplunkevents": true,
                "notifiersDiscord": true,
                "notifiersDiscordWebhook": true,
                "notifiersEmail": true,
                "notifiersOpsgenie": false,
                "notifiersPagerduty": false,
                "notifiersSlack": true,
                "notifiersWebhook": false,
                "tracing": false
            }
        },
        "externalPlan": {
            "startingOn": "0001-01-01T00:00:00Z",
            "endingBefore": "0001-01-01T00:00:00Z",
            "trialed": false,
            "trialEndingBefore": "0001-01-01T00:00:00Z",
            "state": "empty",
            "nextBillingDate": "0001-01-01T00:00:00Z",
            "planID": "",
            "planInstanceID": ""
        },
        "metaCreated": "2021-05-27T12:45:29.317279107Z",
        "metaModified": "2022-12-12T19:18:12.167484Z",
        "metaVersion": "1670872692167484000"
    }
]

Was this page helpful?