Retrieve org

GET/v2/orgs/{id}

Retrieves an organization the authenticated user is a member of, including its plan and license limits. Requires a personal access token (PAT).

Parameters

Property	Type	Location	Description
`id`	`string`Required	`path`

Request

curl -X GET 'https://api.axiom.co/v2/orgs/ID' \
  -H 'Authorization: Bearer API_TOKEN'

Try itRun this request against your Axiom organization

Credentials stay in this browser tab and are only sent to Axiom when you run the request.

API token Requiredid pathRequired

Response

200Organization.

application/json

404Organization not found, or the user isn't a member of it.

Property	Type	Description
`defaultEdgeDeployment`	`string`
`firstFailedPayment`	`string`
`id`	`string`Required
`lastUsageSync`	`string`Required
`license`	`object`Required
`apiRateLimitPerSecond`	`integer<uint64>`Required
`billingPeriodEnd`	`string<date-time>`Required
`billingPeriodStart`	`string<date-time>`Required
`defaultEdgeDeployment`	`string`Required
`edgeDeployments`	`string[]`Required
`expiresAt`	`string<date-time>`
`features`	`object`Required
`id`	`string`Required
`issuedAt`	`string<date-time>`Required
`issuedTo`	`string`Required
`issuer`	`string`Required
`maxAuditWindowSeconds`	`integer<uint64>`Required
`maxDatasets`	`integer<uint64>`Required
`maxEndpoints`	`integer<uint64>`Required
`maxFields`	`integer<uint64>`Required
`maxMonitors`	`integer<uint64>`Required
`maxQueryWindowSeconds`	`integer<uint64>`Required
`maxUsers`	`integer<uint64>`Required
`monthlyIngestGb`	`integer<uint64>`Required
`monthlyQueryGbHours`	`integer<uint64>`Required
`storageAllowanceGB`	`integer<uint64>`
`tier`	`string`Required
`validFrom`	`string<date-time>`Required
`withAuths`	`string[]`Required
`metaCreated`	`string`
`metaModified`	`string`
`metaVersion`	`string`
`name`	`string`Required
`paymentStatus`	`string`Required
`plan`	`string`Required
`planCreated`	`string`Required
`primaryEmail`	`string`Required
`role`	`string`