API Tokens

List API tokens

Changed on

Retrieve a list of all API tokens for the organization.

Note: This endpoint accepts a session credential only. An API token is rejected with 401 ERR_API_TOKEN_NOT_ALLOWED; an OAuth access token with 403 ERR_FORBIDDEN.

Note: API Token APIs are available on all cloud-hosted plans, and on licensed self-hosted deployments (Business plan and above).

Beta: These APIs are currently in beta and subject to change in future releases.

get/api/v3/meta/tokens

Request

Query parameters

limitinteger

Number of tokens to return. Defaults to 25 and is capped per deployment.

offsetinteger

Number of tokens to skip. An offset at or past the total row count is rejected. Ignored when baseId is set.

baseIdstring

Return only the tokens scoped to this base, unpaginated. Used by the base settings token list.

Response

List of API tokens

Example response

{
  "list": [
    {
      "id": 5,
      "title": "Github Integration",
      "created_at": "2025-12-30 15:17:24+00:00",
      "updated_at": "2025-12-30 15:17:24+00:00",
      "scopes": [
        {
          "resource_type": "base",
          "resource_id": "p_abc123def456"
        }
      ],
      "token_prefix": "nc_pat_wxAFz",
      "expiry": "2026-12-30 15:17:24+00:00",
      "enabled": true,
      "ip_allowlist": [
        "203.0.113.4",
        "10.0.0.0/8"
      ],
      "self_lockout_warning": true,
      "caller_ip": "203.0.113.4",
      "caller_ip_internal": true,
      "last_used_at": "2025-12-31 09:02:11+00:00"
    }
  ],
  "pageInfo": {
    "totalRows": 3,
    "page": 1,
    "pageSize": 25
  }
}

Changes

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      api operation id tokens-list was added

    • info

      the endpoint scheme security xc-token was removed from the API

    • info

      added the new optional query request parameter baseId

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter offset

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status