Authentication

curl https://api.open.cx/contacts \
  -H "Authorization: Bearer YOUR_API_KEY"

​

Generate an API key

1. Go to Settings → Access in the OpenCX dashboard.
2. Click Create API Key.
3. Give it a name (e.g. “Production”, “Staging”).
4. Choose access level:
   • Full access — the key can call every endpoint with no restrictions.
   • Custom scopes — select only the resources and actions (read / write) this key needs.
5. Copy the key.

​

Using the key

Authorization: Bearer ocx_live_abc123...

curl -X GET https://api.open.cx/contacts \
  -H "Authorization: Bearer YOUR_API_KEY"

const response = await fetch("https://api.open.cx/contacts", {
  headers: {
    Authorization: "Bearer YOUR_API_KEY",
  },
});

import requests

response = requests.get(
    'https://api.open.cx/contacts',
    headers={'Authorization': 'Bearer YOUR_API_KEY'},
)

​

Scopes

​

Available scopes

​

Error responses

{
  "statusCode": 401,
  "message": "Unauthorized",
  "error": "Unauthorized"
}

{
  "statusCode": 403,
  "message": "This API key does not have the required scope: \"tags:read\"."
}

​

Best practices

• Never commit keys to source control. Use environment variables or a secrets manager.
• Rotate keys periodically. You can create multiple keys and revoke old ones from the dashboard.
• Use separate keys for each environment (production, staging, development) so revoking one doesn’t break the others.
• Use scoped keys in production. Grant only the permissions each integration needs (principle of least privilege).
• Prefer separate keys per integration so revoking one doesn’t break others, and each gets only the scopes it needs.