Skip to main content
GET
/
v2
/
api-keys
List API keys
curl --request GET \
  --url https://api.orq.ai/v2/api-keys \
  --header 'Authorization: Bearer <token>'
{
  "object": "<string>",
  "data": [
    {
      "api_key_id": "<string>",
      "name": "<string>",
      "owner": {
        "user": {
          "user_id": "<string>"
        },
        "service_account": {}
      },
      "project_scope": {
        "all": {},
        "single": {
          "project_id": "<string>"
        }
      },
      "permission_mode": 123,
      "access": {},
      "token_prefix": "<string>",
      "status": 123,
      "constraints": {
        "expires_at": "2023-11-07T05:31:56Z",
        "budget": {
          "period": 123,
          "amount": 123,
          "token_limit": "<string>"
        },
        "rate_limit": {
          "requests_per_minute": 123
        }
      },
      "created_by_id": "<string>",
      "updated_by_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "last_used_at": "2023-11-07T05:31:56Z",
      "legacy_token_family": 123,
      "legacy_key_id": "<string>"
    }
  ],
  "has_more": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.orq.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer<int32>

Page size, 1–200. Unset uses the server default (25).

starting_after
string

Cursor for forward pagination. Set to the api_key_id of the last item from the previous page.

ending_before
string

Cursor for backward pagination. Set to the api_key_id of the first item from the previous page.

project_id
string

Optional filter: only return keys belonging to this project. When omitted, returns workspace-scoped and any single-project keys.

status
integer<enum>

Optional filter: only return keys with this status.

Response

200 - application/json

OK

object
string

Object discriminator for list responses; always list.

data
object[]

Page of api-keys, ordered newest first. token_hash and api_key are always elided in list responses.

has_more
boolean

Whether more api-keys are available in the selected pagination direction.