List API keys

GET

/api/api-keys

curl --request GET \
  --url https://api.sipstack.com/api/api-keys \
  --header 'Authorization: Bearer <token>'

const url = 'https://api.sipstack.com/api/api-keys';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

import axios from 'axios';

const options = {
  method: 'GET',
  url: 'https://api.sipstack.com/api/api-keys',
  headers: {Authorization: 'Bearer <token>'}
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

Authorizations

bearerAuth

Responses

200

All API keys for your organization (secrets are never included).

application/json

object

success

boolean

data

Array<object>

API key record (the secret value itself is never returned after creation).

object

integer

uuid

string format: uuid

name

string

key_prefix

First characters of the key, for identification.

string

environment

string

Allowed values: production test

scopes

Capability scopes granted to the key (e.g. ["sms:send","calls:read"]), or ["*"] for full access. null/[] on an unscoped or legacy key — such a key holds no scopes and is denied every scoped endpoint (403 insufficient_scope); it is not treated as full access.

Array<string>

nullable

expires_at

When the key expires. null = never expires. An expired key is rejected with 401.

string format: date-time

nullable

last_used_at

string format: date-time

nullable

is_active

boolean

created_at

string format: date-time

requests_today

integer

requests_this_month

integer

requests_total

integer

Example

{
  "data": [
    {
      "name": "CRM Integration",
      "key_prefix": "sk_live_a1b2",
      "environment": "production",
      "scopes": [
        "*"
      ]
    }
  ]
}

401

Not authenticated.

403

Missing permission.