Skip to main content

Authentication

All CRM API endpoints require authentication via Bearer token.

Authorization Header

Authorization: Bearer <jwt_token>

Required Scopes

ScopeDescription
crm:readRead profiles, timeline, notes
crm:writeCreate/update profiles, add notes
crm:adminMerge profiles, manage segments
crm:campaignsManage campaigns and journeys
crm:socialManage social connections and posts

Multi-Tenancy

All requests must include a tenantId. This is typically extracted from the JWT token or passed as a query parameter.

GET /api/v1/customers?tenantId=tenant_123

Rate Limits

Endpoint TypeLimit
Read operations1000/minute
Write operations100/minute
Campaign execution10/minute
Social publishing30/minute
Bulk operations10/minute

Rate limit headers are included in responses:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1734184800