For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
WebsiteDashboardGet API key
  • Get Started
    • Welcome
    • Quickstart
    • Agent onboarding
    • Service keys
    • Core Concepts
  • Guides
    • Hosted Mode
    • Webhook Mode
    • Audio Mode
    • SMS and Conversations
    • Compliance and Consent
    • Billing and Usage
    • Voice zones
    • SMS zones
  • Reference
    • Authentication
    • API Overview
    • Errors and Testing
  • API Reference
      • GETList child API keys
      • POSTMint a child API key
      • GETGet a child API key
      • DELRevoke a child API key
      • PATCHUpdate a child API key
      • POSTAtomically rotate a child API key
  • Changelog
    • Cloudflare Insights CSP
    • Agent-native key management
    • Postpaid auto-charge
    • Cents-honest pricing
    • Stripe payments foundation
    • Hosted/webhook mode rename
    • Upgrading to v0.5.7.0
LogoLogo
WebsiteDashboardGet API key
API ReferenceKeys

List child API keys

GET
https://saperly.com/api/v1/keys
GET
/api/v1/keys
1const url = 'https://saperly.com/api/v1/keys';
2const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
3
4try {
5  const response = await fetch(url, options);
6  const data = await response.json();
7  console.log(data);
8} catch (error) {
9  console.error(error);
10}
1{
2  "keys": [
3    {
4      "id": "string",
5      "key_prefix": "sk_live_abc",
6      "environment": "live",
7      "name": "string",
8      "agent_label": "string",
9      "line_id": "string",
10      "permissions": "full",
11      "monthly_cap_cents": 1,
12      "monthly_spend_cents": 1,
13      "created_at": "2024-01-15T09:30:00Z",
14      "revoked_at": "2024-01-15T09:30:00Z",
15      "last_used_at": "2024-01-15T09:30:00Z",
16      "rotated_from": "string",
17      "created_by_service_key_id": "string"
18    }
19  ],
20  "total": 1
21}
Lists child API keys minted by the authenticated service key. Cross-service-key reads are NOT permitted: a service key only sees the keys it minted. Revoked rows are excluded from the list (use `GET /api/v1/keys/{id}` to read a specific revoked key). Every successful read writes a `service_key_list_read` compliance event (audit-of-audit). Rate-limited to 600 requests per hour per service key.
Was this page helpful?
Previous

Mint a child API key

Next
Built with

Lists child API keys minted by the authenticated service key. Cross-service-key reads are NOT permitted: a service key only sees the keys it minted. Revoked rows are excluded from the list (use GET /api/v1/keys/{id} to read a specific revoked key).

Every successful read writes a service_key_list_read compliance event (audit-of-audit). Rate-limited to 600 requests per hour per service key.

Authentication

AuthorizationBearer

Service keys (sk_svc_*) authenticate the /v1/keys/* management plane. Send as Authorization: Bearer <service-key>. Service keys are minted only from the portal (Settings → Service Keys); there is no API path to mint another service key.

Query parameters

limitintegerOptional1-100Defaults to 50

Maximum number of results (1-100)

offsetintegerOptional>=0Defaults to 0
Number of results to skip

Response

List of child API keys
keyslist of objects
totalinteger

Errors

401
Unauthorized Error
429
Too Many Requests Error