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

# Getting Started

> Roosted HR Enterprise API reference

<Note>
  The Roosted API is organized around REST. All requests and responses use JSON.
  Sandbox and production API keys are available by contacting [support@roostedhr.com](mailto:support@roostedhr.com).
</Note>

## Welcome

The Roosted API gives you programmatic access to the Roosted workforce scheduling platform. Use it to manage events, shifts, workers, clients, time tracking, and more — directly from your own systems.

<CardGroup cols={1}>
  <Card title="Base URL (Production)" icon="server">
    ```
    https://api.roostedhr.com/api/1_12
    ```
  </Card>

  <Card title="Base URL (Sandbox)" icon="flask">
    ```
    https://sandbox.roostedhr.com/api/1_12
    ```
  </Card>
</CardGroup>

## Authentication

All API endpoints require an API key. Include it in the `X-API-KEY` header of every request.

```bash theme={null}
curl -X GET https://api.roostedhr.com/api/1_12/events \
  -H "X-API-KEY: YOUR_API_KEY"
```

Contact [support@roostedhr.com](mailto:support@roostedhr.com) to request your sandbox and production API keys.