Skip to main content
GET
cURL

Headers

Authorization
string
required

Bearer token. Format: Bearer <api_key>

Query Parameters

limit
integer<int32>
default:25

Maximum number of items to return. Defaults to 25, max 100.

cursor
string

Cursor for the next page of results, returned in previous responses.

role
enum<string>

Which side of the grant the caller is on. Omit to return both directions. Filter for which side of the grant the caller is on. Omitted = both directions.

Available options:
granter,
authorized
status
enum<string>

Filter by lifecycle status. Omit to return all states (including REVOKED). Lifecycle status of an authorization grant.

  • PENDING — Row exists, the granter has not signed yet. The authorized org cannot act on the granter's behalf.
  • ACTIVE — Granter has signed (signedAt is set). The authorized org may act on the granter's behalf when the Nxos-On-Behalf-Of header is set.
  • REVOKED — Previously active or pending, then revoked by either party. Kept for audit; never reverts to ACTIVE.
Available options:
PENDING,
ACTIVE,
REVOKED
type
enum<string>

Filter by grant type. Currently only LOA exists. Type of cross-org authorization. Today the only value is LOA (Letter of Authorization), which lets the authorized organization act on the granter's behalf via the platform API when the Nxos-On-Behalf-Of header is set.

Available options:
LOA

Response

The request has succeeded.

Paginated list envelope. All list endpoints return this shape.

object
enum<string>
required

Object type. Always list for paginated responses.

Available options:
list
data
object[]
required

Array of results.

hasMore
boolean
required

Whether more results are available beyond this page.

nextCursor
string | null
required

Cursor to pass as cursor query parameter for the next page. Null when there are no more results.