Skip to main content

API Keys / Tokens

GET/v1/orgs/{org_id}/tokens

List Tokens

List tokens for an organization, optionally filtered by project/type.

Bearer token or X-API-Keyscope: adminoperation_id: tokens.list

Authentication

Send either Authorization: Bearer <token> or X-API-Key: <token>. The caller must hold the "admin" role on the organization. Admin token — create via POST /v1/orgs/{org_id}/tokens/admin. Org-wide scope, so keep it tightly held. Requests without a valid credential are rejected with 401.

SDK install

pip install znyx-sdknpm install @znyx/sdk

Code samples

Request

curl -X GET "$ZNYX_API_URL/v1/orgs/00000000-0000-0000-0000-000000000000/tokens" \
  -H "Authorization: Bearer $ZNYX_TOKEN"

Response

application/json

Successful Response

[
  {
    "id": 0,
    "key_prefix": "string",
    "key_type": "string",
    "org_id": null,
    "project_id": null,
    "environment_id": null,
    "scopes": [
      "string"
    ],
    "is_active": false,
    "expires_at": null,
    "created_at": "string"
  }
]

Schema: TokenResponse[]

Path parameters

NameTypeRequiredDescription
org_id#pathstringrequired-

Query parameters

NameTypeRequiredDescription
project_id#querystring | nulloptional-
key_type#querystring | nulloptional-

Header parameters

NameTypeRequiredDescription
X-API-Key#headerstring | nulloptional-
authorization#headerstring | nulloptional-

Responses

StatusDescription
200Successful Response
422Validation Error

Response schema

idrequiredinteger
key_prefixrequiredstring
key_typerequiredstring
org_idstring | null
project_idstring | null
environment_idstring | null
scopesstring[]
is_activerequiredboolean
expires_atstring | null
created_atrequiredstring

Errors & what triggers them

CodeTriggerFix
401Missing or expired Authorization header.-
403Token does not have org access (wrong org_id, or insufficient role).-
404Resource does not exist in this org.-