Skip to main content

ApiKeyListResponse

A list of API keys. Not cursor-paginated: keys-per-owner is small, so all are returned (a deliberate exception to the pagination convention).

items object[]

The keys owned by the principal (or by the requested owner, for super-users)

  • Array [
  • idstring

    The key id

    Example: 7Hb2Kp9QvL3mNx0R8tZ4
    namestring

    Human-readable label for the key

    Example: billing-sync
    prefixstring

    Token prefix (e.g. adb_live)

    Example: adb_live
    displayLast4string

    Last 4 characters of the token, for identification in a UI

    Example: a1b2
    superUserboolean

    True if the key has cross-network (super-user) access; then scopes is empty

    Example: false
    statusstring

    Key status

    Possible values: [active, revoked, expired]

    Example: active
    scopes object[]

    Per-network access the key holds

  • Array [
  • networkIdstring

    The network this scope grants access to

    Example: 7Hb2Kp9QvL3mNx0R8tZ4
    rolestring

    Role held on this network

    Possible values: [read_only, administrator]

    Example: read_only
    networkUrlstring

    Link to this network, so the key can navigate without constructing ids

    Example: https://api.adbridge.ai/external/v1/networks/7Hb2Kp9QvL3mNx0R8tZ4
  • ]
  • createdAtdate-time

    When the key was created

    Example: 2026-01-15T09:30:00Z
    lastUsedAtdate-timenullable

    When the key was last used to authenticate a request, if ever

    Example: 2026-01-15T09:30:00Z
    expiresAtdate-timenullable

    When the key expires, if an expiry was set; null means it never expires

    Example: 2026-01-15T09:30:00Z
  • ]
  • ApiKeyListResponse
    {
    "items": [
    {
    "id": "7Hb2Kp9QvL3mNx0R8tZ4",
    "name": "billing-sync",
    "prefix": "adb_live",
    "displayLast4": "a1b2",
    "superUser": false,
    "status": "active",
    "scopes": [
    {
    "networkId": "7Hb2Kp9QvL3mNx0R8tZ4",
    "role": "read_only",
    "networkUrl": "https://api.adbridge.ai/external/v1/networks/7Hb2Kp9QvL3mNx0R8tZ4"
    }
    ],
    "createdAt": "2026-01-15T09:30:00Z",
    "lastUsedAt": "2026-01-15T09:30:00Z",
    "expiresAt": "2026-01-15T09:30:00Z"
    }
    ]
    }