Skip to main content
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 lists every endpoint and webhook event with its request and response schemas.

​
Start here

  1. Create an API token in Breakroom.
    Creating API tokens is a closed feature. Contact 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.
  4. Browse the API Reference. Each endpoint page lists its parameters with request and response examples.

​
Next steps

  • Errors — shared error body and status codes.
  • Pagination — limit / offset and hasMore.
  • Webhooks — receive events such as time_off_approved.