Identify the API key's organization

GET

/api/v2/me

curl --request GET \
  --url https://api.sipstack.com/api/v2/me \
  --header 'x-api-key: <x-api-key>'

const url = 'https://api.sipstack.com/api/v2/me';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

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/v2/me',
  headers: {'x-api-key': '<x-api-key>'}
};

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

Returns the organization the presented API key belongs to, plus the key’s environment. Useful as a connectivity/auth check.

Authorizations

apiKeyAuth

Responses

200

Organization identity for the key.

application/json

Identity of the organization the presented API key belongs to.

object

success

boolean

data

object

org

object

Your organization’s id.

string format: uuid

name

string

nullable

apiKey

object

string

environment

string

nullable

Allowed values: production test

scopes

The key’s actual stored scopes — the same set enforced per endpoint. ["*"] for a full-access key, or a narrow list (e.g. ["sms:read","contacts:read"]) for a scoped key; an unscoped or legacy key reports [] and is denied every scoped endpoint.

Array<string>

Example

{
  "success": true,
  "data": {
    "apiKey": {
      "environment": "production"
    },
    "scopes": [
      "sms:read",
      "contacts:read"
    ]
  }
}

401

Missing or invalid API key.

application/json

Inline error shape used by the messaging API and management endpoints.

object

success

boolean

error

string

Example

{
  "success": false,
  "error": "Recipient phone number (to) is required"
}

500

Internal error.

application/json

Inline error shape used by the messaging API and management endpoints.

object

success

boolean

error

string

Example

{
  "success": false,
  "error": "Recipient phone number (to) is required"
}