API Keys

List API keys

Returns the API keys belonging to the authenticated account.

get/v1/api-keys

Query parameters

labelstring

Filters API keys by label. Matches partial values.

Response

Returns the list of API keys.

idinteger required

API key ID.

labelstring required

API key label.

valuestring required

API key value.

activeboolean required

Indicates whether the API key is active.

restrictedboolean required

Indicates whether IP restrictions are enabled. When enabled, the API key works only from IP addresses in permitted_ips.

permitted_ipsstring[] required

List of permitted IP addresses. If restricted is false, an empty list means no IP restrictions. If restricted is true, an empty list prevents all requests.

scopes_enabledboolean required

When true, the key is restricted to the permissions defined in the scope fields below. When false, the key has full access.

last_used_atstring date-time nullable required

Timestamp of the most recent authenticated request made with this key.

created_atstring date-time required

Creation date and time in ISO 8601 format.

Example response

[
  {
    "id": 123,
    "label": "Production API Key",
    "value": "abc123def456ghi789jkl012mno345pqr678stu901vwx234yz",
    "active": true,
    "restricted": true,
    "permitted_ips": [
      "192.168.1.1",
      "10.0.0.1"
    ],
    "scopes_enabled": true,
    "last_used_at": "2026-04-20T15:42:11Z",
    "numbers": {
      "allow": "read"
    },
    "trunks": {
      "allow": "read"
    },
    "calls": {
      "allow": "read"
    },
    "messages": {
      "allow": "read"
    },
    "recordings": {
      "allow": "read"
    },
    "campaigns": {
      "allow": "read"
    },
    "two_fa": {
      "allow": "read"
    },
    "validator": {
      "allow": "read"
    },
    "webhooks": {
      "allow": "read"
    },
    "embeddable": {
      "allow": "read"
    },
    "billing": {
      "allow": "read"
    },
    "account": {
      "allow": "read"
    },
    "subaccounts": {
      "allow": "read"
    },
    "created_at": "2024-01-15T10:30:00Z"
  }
]

Changes

Changed in 4 of the 50 revisions of this API.328

Jun 15, 202676b9bb35619f33See the full diff
- ▲
  removed the required property items/is_active from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property items/is_restriction from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property items/is_scopes_enabled from the response with the 200 status
  response-required-property-removed
- ○
  added the required property items/active to the response with the 200 status
  response-required-property-added
- ○
  added the required property items/restricted to the response with the 200 status
  response-required-property-added
- ○
  added the required property items/scopes_enabled to the response with the 200 status
  response-required-property-added
This revision also has 42 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 29, 2026d4adae930be523See the full diff
- ○
  added the non-success response with the status 401
  response-non-success-status-added
- ○
  the response property items/created_at became required for the status 200
  response-property-became-required
- ○
  the response property items/id became required for the status 200
  response-property-became-required
- ○
  the response property items/is_active became required for the status 200
  response-property-became-required
- ○
  the response property items/is_restriction became required for the status 200
  response-property-became-required
- ○
  the response property items/label became required for the status 200
  response-property-became-required
- ○
  the response property items/permitted_ips became required for the status 200
  response-property-became-required
- ○
  the response property items/value became required for the status 200
  response-property-became-required
- ○
  added the required property items/account to the response with the 200 status
  response-required-property-added
- ○
  added the required property items/billing to the response with the 200 status
  response-required-property-added
- ○
  added the required property items/calls to the response with the 200 status
  response-required-property-added
- ○
  added the required property items/campaigns to the response with the 200 status
  response-required-property-added
- ○
  added the required property items/embeddable to the response with the 200 status
  response-required-property-added
- ○
  added the required property items/is_scopes_enabled to the response with the 200 status
  response-required-property-added
- ○
  added the required property items/last_used_at to the response with the 200 status
  response-required-property-added
- ○
  added the required property items/messages to the response with the 200 status
  response-required-property-added
- ○
  added the required property items/numbers to the response with the 200 status
  response-required-property-added
- ○
  added the required property items/recordings to the response with the 200 status
  response-required-property-added
- ○
  added the required property items/subaccounts to the response with the 200 status
  response-required-property-added
- ○
  added the required property items/trunks to the response with the 200 status
  response-required-property-added
- ○
  added the required property items/two_fa to the response with the 200 status
  response-required-property-added
- ○
  added the required property items/validator to the response with the 200 status
  response-required-property-added
- ○
  added the required property items/webhooks to the response with the 200 status
  response-required-property-added
Apr 20, 20262e48fd9894e11See the full diff
- ○
  api operation id api_keys_list was added
  api-operation-id-added
This revision also has 163 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 12, 2026fabaadf195a91See the full diff
- ○
  endpoint added
  endpoint-added

Full history