> For the complete documentation index, see [llms.txt](https://docs.scaleconnect.com.au/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.scaleconnect.com.au/api/rest-api/scaleapp-rest-api.md).

# ScaleApp REST API

{% @scale-docs-page-title/page-title title="ScaleApp REST API" %}

{% hint style="warning" %}
**Confirm before publishing:** refresh the source against the current R16 deployment, resolve remaining request/response audit findings, identify internal-only operations and fields, verify authentication per route, and select the operations that may become a public versioned API. The generated reference below is an internal contract snapshot, not an approved partner API.
{% endhint %}

This reference renders the current Scale backend OpenAPI copy with methods, paths, request DTOs, success responses and schemas. It is the place to inspect **what R16 describes today** before choosing a smaller public contract.

## Use the reference

1. Find an operation by tag or search for its path.
2. Read its request body and path/query parameters, including required, nullable and enum rules.
3. Check the documented response status and schema. Some R16 routes return different shapes for different outcomes; do not assume one wrapper applies to every operation.
4. Compare the route to the deployed behaviour before using it as an external integration contract.

The source host in the reviewed spec is `https://r16.app`. The raw runtime description is available from the backend's `/api/json` endpoint. The GitBook copy is a private selection draft; editing the generated page does not change the deployed API or its DTOs.

## Authentication and an example

Existing application routes use the product's user bearer token and route-specific guards. `GET /v1/auth/me` is a small authenticated read for checking a session:

```bash
curl --request GET 'https://r16.app/v1/auth/me' \
  --header 'Authorization: Bearer <user-token>' \
  --header 'Accept: application/json'
```

Do not substitute a proposed partner API key for a product user token. Internal and development operations in the generated spec must remain excluded from a public selection even when their schema is visible here.

## Choosing public operations

A public API should have one stable purpose, a caller-specific authorization rule, an explicit request DTO, a truthful success and error contract, and a serializer that omits internal-only fields. The selected operation set becomes a **separate** OpenAPI document and route policy. Removing a field from that document alone will not prevent R16 from returning it.

The generated **ScaleApp REST API Reference** below contains the operation and model pages.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.scaleconnect.com.au/api/rest-api/scaleapp-rest-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.