List customer API keys (by external customer id)

GET

https://api.agentpaid.io/api/v2/customers/external/:externalId/api-keys

GET

/api/v2/customers/external/:externalId/api-keys

import { PaidClient } from "@paid-ai/paid-node";
async function main() {
    const client = new PaidClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.customers.listCustomerApiKeysByExternalId({
        externalId: "customer_123",
    });
}
main();

{
  "data": [
    {
      "id": "a3f8c2d1-7b4e-4f9a-8c6d-2e1f0a9b3c5d",
      "name": "Production API Key",
      "description": "Used by the customer's production environment to report usage",
      "customerId": "cus_abc123",
      "customerExternalId": "customer_123",
      "scopes": [
        "write:usage"
      ],
      "keyPrefix": "paid_ck_live_3f9",
      "last4": "7x2z",
      "status": "ACTIVE",
      "createdAt": "2024-11-01T08:00:00Z",
      "lastUsedAt": "2024-12-10T14:22:35Z",
      "expiresAt": "2025-11-01T08:00:00Z",
      "revokedAt": null
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "total": 3,
    "hasMore": false
  }
}

Lists this customer’s API keys, newest first and paginated, revoked and expired ones included. The secret is never returned; keyPrefix and last4 identify each key. Addresses the customer by your external customer id.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Path parameters

externalIdstringRequired>=1 character

Customer ID from your system, stored on Paid as the customer’s externalId.

Query parameters

limitintegerOptional1-100Defaults to 10

offsetintegerOptional>=0

Response

200

datalist of objects

paginationobject

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error