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
  • Obtaining Your API Key
  • Do not share your API key publicly or expose it in client-side code. Treat your API key as a secret and store it securely.Required Headers
  • Example Request
  • Common Errors
Get Started

Authorization Guide

Was this page helpful?
Previous

Webhooks

Next
Built with

Our Public API uses Bearer token authentication and a required X-Plan-Manager-Id header to scope all requests to a plan manager.

Obtaining Your API Key

Head to Settings -> API Keys to generate an API Key

Do not share your API key publicly or expose it in client-side code. Treat your API key as a secret and store it securely.
Required Headers

Every request to the Public API must include:

HeaderDescription
AuthorizationBearer <your_api_key>
X-Plan-Manager-IdPlan manager UUID. Must be one of the plan manager IDs associated with your API key.

Example Request

$curl -X GET 'https://api.caresquareapi.com/api/public/v1/invoices?limit=20&offset=0' \
>  -H 'Authorization: Bearer <YOUR_API_KEY>' \
>  -H 'X-Plan-Manager-Id: <PLAN_MANAGER_UUID>'

Common Errors

  • 401 Unauthorized: Missing or invalid Authorization header (e.g. wrong or expired API key).
  • 400 Bad Request: Missing or invalid X-Plan-Manager-Id (e.g. not a valid UUID).
  • 403 Forbidden: Your API key is not allowed to access the requested plan manager (the X-Plan-Manager-Id is not in the key’s allowed list).
  • 429 Too Many Requests: Rate limit exceeded.