Annotation endpoints
API token endpoints
Dataset endpoints
Monitor endpoints
Notifier endpoints
Organization endpoints
Role-based access control endpoints
Starred queries endpoints
User endpoints
Organization endpoints
Retrieve org
Retrieve org
GET
/
orgs
/
{id}
curl --request GET \
--url https://api.axiom.co/v2/orgs/{id} \
--header 'Authorization: Bearer <token>'
{
"externalPlan": {
"endingBefore": "2023-11-07T05:31:56Z",
"nextBillingDate": "2023-11-07T05:31:56Z",
"planID": "<string>",
"planInstanceID": "<string>",
"startingOn": "2023-11-07T05:31:56Z",
"state": "active",
"trialEndingBefore": "2023-11-07T05:31:56Z",
"trialed": true
},
"firstFailedPayment": "<string>",
"id": "<string>",
"lastUsageSync": "<string>",
"license": {
"apiRateLimitPerSecond": 123,
"expiresAt": "2023-11-07T05:31:56Z",
"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,
"storageAllowanceGB": 123,
"tier": "personal",
"validFrom": "2023-11-07T05:31:56Z",
"withAuths": [
"<string>"
]
},
"metaCreated": "<string>",
"metaModified": "<string>",
"metaVersion": "<string>",
"name": "<string>",
"paymentStatus": "na",
"plan": "personal",
"planCreated": "<string>",
"primaryEmail": "<string>",
"role": "<string>"
}
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Response
200 - application/json
Org
Available options:
active
, inTrial
, incubation
, sunset
, migration
, empty
Available options:
personal
, basicDirect
, teamMonthlyDirect
, teamMonthlyAws
, axiomCloud
, teamPlus
, enterprise
, comped
Available options:
na
, failed
, success
, blocked
Available options:
personal
, basicDirect
, teamMonthlyDirect
, teamMonthlyAws
, axiomCloud
, teamPlus
, enterprise
, comped
Was this page helpful?
curl --request GET \
--url https://api.axiom.co/v2/orgs/{id} \
--header 'Authorization: Bearer <token>'
{
"externalPlan": {
"endingBefore": "2023-11-07T05:31:56Z",
"nextBillingDate": "2023-11-07T05:31:56Z",
"planID": "<string>",
"planInstanceID": "<string>",
"startingOn": "2023-11-07T05:31:56Z",
"state": "active",
"trialEndingBefore": "2023-11-07T05:31:56Z",
"trialed": true
},
"firstFailedPayment": "<string>",
"id": "<string>",
"lastUsageSync": "<string>",
"license": {
"apiRateLimitPerSecond": 123,
"expiresAt": "2023-11-07T05:31:56Z",
"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,
"storageAllowanceGB": 123,
"tier": "personal",
"validFrom": "2023-11-07T05:31:56Z",
"withAuths": [
"<string>"
]
},
"metaCreated": "<string>",
"metaModified": "<string>",
"metaVersion": "<string>",
"name": "<string>",
"paymentStatus": "na",
"plan": "personal",
"planCreated": "<string>",
"primaryEmail": "<string>",
"role": "<string>"
}