v50

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-06-16122182589.7 KB

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"
  }
]

All 131 operations