API Keys

List API keys

Tenant-scoped only (a number-scoped key gets 403 NUMBER_SCOPE_NOT_ALLOWED, and an OAuth grant must be full-tenant). Returns a lean flat list — one item per tenant number — with numberId, number, displayName, keyId, keyLast4 and the real usable value (key field) when the key was created with encryption enabled (revealable: true). Legacy keys come back with key: null and revealable: false (regenerate that number to obtain a usable value).

Requires a tenant-scoped key.

GET

api-keys

List API keys

curl --request GET \
  --url https://pilotstatus.com.br/v1/api-keys \
  --header 'x-api-key: <api-key>'

[
  {
    "numberId": "wn_1",
    "number": "5511999999999",
    "displayName": "Suporte",
    "keyId": "k_aaa",
    "keyLast4": "wxyz",
    "key": "ps_4f1c...real...wxyz",
    "revealable": true
  },
  {
    "numberId": "wn_2",
    "number": "5511888888888",
    "displayName": "Vendas",
    "keyId": "k_bbb",
    "keyLast4": "abcd",
    "key": null,
    "revealable": false
  }
]

Authorizations

x-api-key

string

header

required

Your ps_ API key

Response

List keys (tenant key — all numbers)

Analytics dashboard

Regenerate a number's API key

⌘I

List API keys

curl --request GET \
  --url https://pilotstatus.com.br/v1/api-keys \
  --header 'x-api-key: <api-key>'

[
  {
    "numberId": "wn_1",
    "number": "5511999999999",
    "displayName": "Suporte",
    "keyId": "k_aaa",
    "keyLast4": "wxyz",
    "key": "ps_4f1c...real...wxyz",
    "revealable": true
  },
  {
    "numberId": "wn_2",
    "number": "5511888888888",
    "displayName": "Vendas",
    "keyId": "k_bbb",
    "keyLast4": "abcd",
    "key": null,
    "revealable": false
  }
]