> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.caresquareapi.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.caresquareapi.com/_mcp/server.

# Welcome to our developer documentation

> Here you'll find information to get started with the Caresquare Public API.

Welcome to the Caresquare API docs. The Public API lets you manage participants, team members, notes, tasks, providers, invoices, and invoice view sessions — all scoped by plan manager and secured with a Bearer token and the **X-Plan-Manager-Id** header.

> **Warning**
>
> These docs are currently under construction. Please contact support to discuss your use-case and be issued with an API Key.

## API overview

| Area                      | Endpoints                         | Description                                                                                                |
| ------------------------- | --------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| **Participants**          | List, Create, Get, Update, Delete | Manage NDIS participants (e.g. name, participant number, email, state, `participant_receives_statements`). |
| **Team members**          | List, Create, Get, Update, Delete | Add and remove people on a participant, including permissions such as View Budget and Email Statements.    |
| **Notes**                 | List, Create, Get, Update, Delete | Participant, provider, or invoice notes.                                                                   |
| **Tasks**                 | List, Create, Get, Update         | Participant tasks (assignee, due date, priority, completion).                                              |
| **Providers**             | List, Create, Get, Update, Delete | Manage providers (entity name, ABN, registration number, email).                                           |
| **Invoices**              | List, Get by ID                   | List invoices and get a single invoice with line items (totals, status, S3 key, etc.).                     |
| **Invoice view sessions** | List, Get by ID                   | List and retrieve invoice view sessions.                                                                   |
| **Invoice status**        | POST `/invoices/status`           | Check invoice status by provider email and invoice number (same shape as remittance portal).               |
| **Documents**             | Process, Get                      | Submit documents for processing and retrieve results (webhook-driven).                                     |

All list endpoints support **pagination** via `limit` (1–1000, default 20) and `offset` (default 0). Responses include a `pagination` object with `total` and `has_more`.

For large extracts (especially invoices), use **cursor pagination** instead of offset: pass `after=0` on the first request, then `after={pagination.next_cursor}` until `has_more` is false. Cursor pages are ordered by `id` ascending, so new inserts cannot shift rows across page boundaries. `total` is set to `null` on cursor pages to avoid a full-table count.

Base URL: `https://api.caresquareapi.com/api/public/v1`

## Getting Started

#### [API Reference](/api-reference)

#### [Authorisation](/authorisation)

#### [Status Page](https://caresquare.instatus.com)

#### [Slack Support](https://join.slack.com/share/enQtNzExODQ1Mjg0MDkzMS1iNTZiNTQ3NzFhYWYxNTIzNWE2NmQwY2FhZGI3MWQzZWYyYWVkMDQwYTQwM2VjOTExN2ZmNTAxMGRlM2EzNDE2)

#### [Discord Support](https://discord.gg/SUtY9YYSfm)

## Get support

Want to get in touch with the Caresquare team? Reach out via [email](mailto:support@caresquare.au), or by creating a dedicated Slack support channel above. We're here to help!