Authentication

Partner endpoints under /api/v1 are authenticated with an API key.

API key header

Create a key in the Control console (App Store / API keys), then send it on every request:

curl "https://api.control.cm/api/v1/me" \
  -H "x-api-key: YOUR_API_KEY"

Verify the key

GET /api/v1/me returns the key identity (company id, key id, name, rate limit). It does not return company data — use it as a connectivity check.

Rate limits

Each key has a per-minute request limit. Exceeding it returns an HTTP error; the /me response includes the configured limit for that key.

Keep keys secret. Rotate them in the console if compromised.