For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Get supportGet a Demo
  • Get Started
    • Welcome
    • Authorisation
    • Webhooks
  • API Reference
LogoLogo
Get supportGet a Demo
On this page
  • API overview
  • Getting Started
  • Get support
Get Started

Welcome to our developer documentation

Was this page helpful?

Authorization Guide

Next
Built with

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

AreaEndpointsDescription
ParticipantsList, Create, Get, Update, DeleteManage NDIS participants (e.g. name, participant number, email, state).
ProvidersList, Create, Get, Update, DeleteManage providers (entity name, ABN, registration number, email).
InvoicesList, Get by IDList invoices and get a single invoice with line items (totals, status, S3 key, etc.).
Invoice view sessionsList, Get by IDList and retrieve invoice view sessions.
Invoice statusPOST /invoices/statusCheck invoice status by provider email and invoice number (same shape as remittance portal).
DocumentsProcess, GetSubmit documents for processing and retrieve results (webhook-driven).

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

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

Getting Started

API Reference
Authorisation
Status Page
Slack Support
Discord Support

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!