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

# API reference

> Every endpoint, parameter and field, with a “Try it” button on each page.

This reference is built from the API’s own [OpenAPI file](https://api.scoutworks.app/api/v1/openapi.json), so it always matches what the API does.

## Try it

Each endpoint page has a **Try it** button. To use it:

1. Choose the **Demo** server.

2. Paste the [sandbox key](/guides/sandbox) into **Authorization**:

   ```text theme={null}
   sw_live_473adcc6c7236916021f0f24559db36576a53bab071d0f0c08a025adb510b6ab
   ```

3. Choose **Send**.

The request goes straight from your browser to Scoutworks. It does not pass through anyone else’s server. You can use your own key on the **Live** server in the same way.

## Servers

| Server                            | Address                                  |
| --------------------------------- | ---------------------------------------- |
| Live                              | `https://api.scoutworks.app/api/v1`      |
| Demo (made-up data, reset weekly) | `https://api-demo.scoutworks.app/api/v1` |

## The basics

* Send your key as `Authorization: Bearer sw_live_…`. See [Keys and scopes](/guides/authentication).
* Each endpoint page names the scope it needs.
* Lists come back as `{ data, nextCursor }`. See [Pagination](/guides/pagination).
* Errors come back as `{ error: { code, message } }`. See [Errors](/guides/errors).
* Each key can make 120 requests a minute. See [Rate limits](/guides/rate-limits).
* Times are UTC in ISO 8601 (`2026-09-24T18:30:00.000Z`). Dates are `YYYY-MM-DD`.
