---
title: 'REST API'
description: 'Tokens, Bearer access, request example, and links to the OpenAPI reference.'
type: doc
locale: en
canonical: 'https://app.teal.band/en/docs/integrations/rest-api'
updated: '2026-07-30'
---

# REST API

Tokens, Bearer access, request example, and links to the OpenAPI reference.

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:

```http
Authorization: Bearer <token>
```

How to issue, store, and revoke tokens is described in the article
[API tokens](https://app.teal.band/en/docs/integrations/api-tokens.md).

## Request example

```bash
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.

## Full documentation

- [OpenAPI reference](https://app.teal.band/docs/api) — interactive documentation on endpoints, parameters, and
  response schemas.
- [OpenAPI JSON](https://app.teal.band/docs/api.json) — a machine-readable schema for client generators, Postman,
  Insomnia, and contract testing.

## Related pages

- [/docs/api](https://app.teal.band/docs/api)
- [/docs/api.json](https://app.teal.band/docs/api.json)
- [API tokens](https://app.teal.band/en/docs/integrations/api-tokens.md) — Personal tokens and bearer access to \`/api/v1\`.

## Read next

- [About the Knowledge Base](https://app.teal.band/en/docs/knowledge.md) — Catalog of practices and connection to platform recommendations.