Skip to main content
GET
/
api-keys
List API keys
curl --request GET \
  --url https://api.natural.co/api-keys \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "type": "api_key",
      "id": "key_019cd360-4fd6-7bf5-a3b5-821ca7836c14",
      "attributes": {
        "api_key_prefix": "nat_live_abc123__",
        "name": "production-key",
        "scopes": [
          "payments.read",
          "payments.create"
        ],
        "environment": "production",
        "status": "ACTIVE",
        "created_at": "2026-01-04T15:30:00Z",
        "expires_at": "2026-04-04T15:30:00Z",
        "last_used_at": null,
        "revoked_at": null,
        "created_by": null,
        "revoked_by": null
      },
      "relationships": {
        "party": {
          "data": {
            "type": "party",
            "id": "pty_019cd1798d617f65a79cb965dda9eac3"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "has_more": false,
      "next_cursor": null
    }
  }
}

Authorizations

Authorization
string
header
required

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

Headers

X-Agent-ID
string | null

Agent ID (agt_xxx) identifying which agent is making the request.

X-Instance-ID
string | null

Agent session/conversation ID for observability.

Maximum string length: 1024

Query Parameters

status
string | null

Filter by status (ACTIVE or REVOKED)

environment
string | null

Filter by environment (dev or prod)

cursor
string | null

Cursor for pagination

limit
integer
default:50

Max items per page

Required range: 1 <= x <= 100

Response

Successful Response

List of API keys response.

data
ApiKeyResource · object[]
required

List of resources

meta
ResponseMeta · object

Response metadata