Integrations
REST API
Tokens, Bearer access, request example, and links to the OpenAPI reference.
Documentation sections
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 "$TEALBAND_BASE_URL/api/v1/{org}/surveys" \
-H "Accept: application/json" \
-H "Authorization: Bearer $TEALBAND_API_TOKEN"
Replace {org} with the organization ID. For specific endpoint parameters, response format, and error codes, see the full specification.
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.