Getting started

1. Open Settings → API keys and create a key.
2. Choose its role and an expiry within one year. Only roles whose permissions fit within your own are available.
3. Copy the key and save it securely. You can only see the full key once.
4. Set TELEFLOWS_API_KEY in your environment, then send a request:

curl "https://api.teleflows.io/api/v2/api/v2/campaigns?page=1&page_size=20" \
  -H "X-API-Key: $TELEFLOWS_API_KEY"

Authentication and access

Send your key in the X-API-Key header. These endpoints support GET requests only. Do not add a Bearer token. Your key can only read records allowed by both your current role and its assigned role. Use the paths in this reference for integrations.

To rotate a key, create a replacement, update your integration, then revoke the old key in Settings. Expired and revoked keys cannot make requests.

Pagination and dates

Entity lists accept page (starting at 1) and page_size (up to 100). Responses include items, total, page, page_size and pages. Continue until you reach the last page. Available filters are listed on each endpoint. Timestamps use ISO 8601 with a timezone offset.

Errors and limits

• 401: Check your key, expiry and revocation status.
• 403: Your key cannot perform this operation.
• 404: The resource does not exist or is outside your access.
• 405: Use the documented GET method.
• 422: Correct the parameter identified in the response.
• 429: Wait for the Retry-After duration before retrying. Your API keys share an API request allowance that is separate from your browser activity.
• 503: A required service is temporarily unavailable; retry later.

Try a request

Open an endpoint in the reference, enter your API key and select Test Request. The request goes directly to your API. Your key is kept in this page’s memory; it is not saved between visits.