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

# API Reference

> NexSpace REST API reference documentation

# API Reference

The NexSpace API is a REST API that follows standard HTTP conventions.

**Base URL:** `https://api.nexspace365.com`

## Authentication

All requests require a `Bearer` token in the `Authorization` header:

```
Authorization: Bearer nex_live_YOUR_KEY
```

See [Authentication](/authentication) for full details on API keys, OAuth 2.1,
and the device-code flow.

## Content Type

Request and response bodies use JSON:

```
Content-Type: application/json
```

## Versioning

Pin requests with the `NexSpace-Version` header:

```
NexSpace-Version: 2026-05-10
```

See [API Versioning](/concepts/versioning) for details.

## Common Parameters

| Parameter | Type            | Description                |
| --------- | --------------- | -------------------------- |
| `page`    | integer         | Page number (1-based)      |
| `limit`   | integer         | Results per page (max 100) |
| `sort`    | string          | Sort field                 |
| `order`   | `asc` \| `desc` | Sort direction             |

## OpenAPI Specification

The full OpenAPI 3.1 specification is available at:

* **JSON:** [/api/openapi.json](https://api.nexspace365.com/api/openapi.json)
* **YAML:** [/api/openapi.yaml](https://api.nexspace365.com/api/openapi.yaml)

Import it into tools like Postman, Insomnia, or Swagger UI to explore
endpoints interactively.

## Try It

Each endpoint page below has an interactive **Try It** panel (Mintlify API playground).

1. **Bring your own key** — mint a key in the NexSpace app under **Settings → API Keys**. Paste it into the playground’s authorization field (`Bearer nex_live_…`, `nex_test_…`, or `nex_pat_…`).
2. **Sandbox** — there is no separate Try-it base URL. Use `https://api.nexspace365.com` with a `nex_test_…` key; traffic is row-isolated per [Sandbox](/concepts/sandbox).
3. **No shared demo key** — we do not publish a fixed API key in docs. Optional `/api/test/*` routes are intentionally omitted so acceptance criteria stay “your key, your tenant.”

If you only need read-only exploration without a key, import the OpenAPI spec into Postman or Insomnia (links above).

## Endpoints

The **Endpoints** section in the sidebar is generated directly from the
[OpenAPI specification](https://api.nexspace365.com/api/openapi.json), so it
always reflects the live API — every path and method (facilities, staff,
shifts, credentials, API keys, webhooks, usage analytics, OAuth, and MCP),
each with an interactive **Try It** panel.