> ## Documentation Index
> Fetch the complete documentation index at: https://docs.breakroomapp.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

The Breakroom Open API gives integrations access to
Breakroom data over HTTPS. These guides cover shared behavior — authentication,
errors, pagination, and webhooks. The [API Reference](https://docs.breakroomapp.com/api-reference/conversations/get-member-messages.md)
lists every endpoint and webhook event with its request and response schemas.

## Start here

1. Create an **API token** in Breakroom.

   > [!NOTE]
   >
   > Creating API tokens is a closed feature. Contact
   > [hello@breakroomapp.com](mailto:hello@breakroomapp.com) for access.

2. Send `POST` requests with JSON bodies to endpoints under
   `https://api.breakroomapp.com/functions/v1`.

3. Include the token as `Authorization: Bearer …` on every request. See
   [Authentication](https://docs.breakroomapp.com/guides/authentication.md).

4. Browse the [API Reference](https://docs.breakroomapp.com/api-reference/conversations/get-member-messages.md).
   Each endpoint page lists its parameters with request and response examples.

## Next steps

* [Errors](https://docs.breakroomapp.com/guides/errors.md) — shared error body and status codes.
* [Pagination](https://docs.breakroomapp.com/guides/pagination.md) — `limit` / `offset` and `hasMore`.
* [Webhooks](https://docs.breakroomapp.com/guides/webhooks/overview.md) — receive events such as `time_off_approved`.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.