Skip to main content

​
Authentication

All requests use a project API key in the header:

​
Base URL

​
Response shape

Most endpoints return a data object:
List endpoints can also include meta pagination fields.

​
Rate limits

Platform API requests are rate limited by project plan. The limiter is tracked per API key.

​
Workflow execution burst limit

POST /workflows/{workflow_id}/executions has an extra per-workflow burst limiter on top of the general per-minute limit. Successful responses include:
  • X-Burst-RateLimit-Limit
  • X-Burst-RateLimit-Remaining
If the burst limit is exceeded, the API returns 429 Too Many Requests with Retry-After: 1.

​
Rate limit headers

Successful responses can include:
  • X-RateLimit-Limit
  • X-RateLimit-Remaining
When you hit the general Platform API limit, the API returns 429 Too Many Requests with:
  • X-RateLimit-Limit
  • X-RateLimit-Remaining: 0
  • Retry-After: 60

​
Next steps

  • Use the Platform API reference sidebar to jump to customers, setup links, phone numbers, webhooks, WhatsApp data, broadcasts, logs, and team resources.
  • See the workflow execution endpoint for the burst-limited trigger route.