REST API

The REST API is available at /api/v1 and is suitable for scripts, internal services, CI, data exports, and other server-side automation.

For protected endpoints, a personal API token is required. The request is executed on behalf of the user who issued the token and passes the same role and permission checks.

Authorization

Pass the token in the HTTP header:

Authorization: Bearer <token>

How to issue, store, and revoke tokens is described in the article API tokens.

Request example

curl -sS "$PLATFORM_BASE_URL/api/v1/{org}/surveys" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $PLATFORM_API_TOKEN"

Replace {org} with the organization ID. For specific endpoint parameters, response format, and error codes, see the full specification.

Rate limits

The API is protected against overload by request rate limits:

• Authenticated app API: 300 requests per minute per user or IP.
• Payment webhook: 600 requests per minute.
• Public endpoints (/status, knowledge base cards): 300 requests per minute per IP.

When exceeding the limit, the server returns HTTP 429 Too Many Requests with a Retry-After header (seconds to wait) and error body:

{
  "status": 429,
  "message": "Too many requests. Try again in 30 sec.",
  "errors": {}
}

Full documentation

• OpenAPI reference — interactive documentation on endpoints, parameters, and response schemas.
• OpenAPI JSON — a machine-readable schema for client generators, Postman, Insomnia, and contract testing.