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": "apiKey",
      "id": "apy_550e8400e29b41d4a716446655440000",
      "attributes": {
        "apiKeyPrefix": "sk_ntl_prod_sxHp_FRoRTnDEmEH",
        "name": "Production Backend",
        "scopes": [
          "payments.read",
          "payments.create"
        ],
        "environment": "prod",
        "status": "ACTIVE",
        "createdAt": "2026-01-04T15:30:00Z",
        "expiresAt": null,
        "lastUsedAt": null,
        "revokedAt": null,
        "createdBy": "usr_550e8400e29b41d4a716446655440000",
        "revokedBy": null
      },
      "relationships": {
        "party": {
          "data": {
            "type": "party",
            "id": "pty_7c9e6679e29b41d4a716446655440001"
          }
        }
      }
    },
    {
      "type": "apiKey",
      "id": "apy_7f8e4d0012a64ef3bca4d21e44a5c001",
      "attributes": {
        "apiKeyPrefix": "sk_ntl_sandbox_Ab12Cd34Ef56Gh78",
        "name": "Sandbox Integration",
        "scopes": [
          "payments.read",
          "payments.create"
        ],
        "environment": "sandbox",
        "status": "ACTIVE",
        "createdAt": "2026-01-04T15:30:00Z",
        "expiresAt": null,
        "lastUsedAt": null,
        "revokedAt": null,
        "createdBy": "usr_550e8400e29b41d4a716446655440000",
        "revokedBy": null
      },
      "relationships": {
        "party": {
          "data": {
            "type": "party",
            "id": "pty_7c9e6679e29b41d4a716446655440001"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "hasMore": false,
      "nextCursor": 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

Required when X-Agent-ID is present. Session or conversation ID for agent observability.

Maximum string length: 1024

Query Parameters

status
enum<string>

Filter by status (ACTIVE or REVOKED)

Available options:
ACTIVE,
REVOKED
environment
enum<string>

Filter by environment

Available options:
sandbox,
prod
cursor
string

Cursor for pagination

limit
integer
default:50

Max items per page

Required range: 1 <= x <= 100

Response

Successful Response

data
ApiKeyResource · object[]
required
meta
object
required