Welcome to our developer documentation

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

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).
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

Get support

Want to get in touch with the Caresquare team? Reach out via email, or by creating a dedicated Slack support channel above. We’re here to help!