Skip to main content
GET
Read an organization's complimentary access and grants

Authorizations

x-api-key
string
header
required

Organization API key passed as the x-api-key header. The raw key is the header value; do not prefix it with Bearer.

Path Parameters

organizationId
string
required

Query Parameters

history
enum<string>
default:0
Available options:
0,
1
cursor
string

Opaque cursor returned as nextCursor by the previous page. Omit for the first page.

Required string length: 1 - 200
limit
integer
default:50

Maximum grants per page, from 1 to 100; defaults to 50.

Required range: 1 <= x <= 100

Response

Organization control panel.

enabled
boolean
required
generatedAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
access
object
required
freeAuto
object
required
grants
object[]
required
legacyWebAccess
boolean
required
nextCursor
string | null
required

Pass as cursor to fetch the next grants page; null on the last page.