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 support Get a Demo

Get Started
API Reference

Get support Get a Demo

API Reference Participants

List participants

GET

https://api.caresquareapi.com/api/public/v1/participants

GET

/api/public/v1/participants

$ curl https://api.caresquareapi.com/api/public/v1/participants \
>      -H "Authorization: Bearer <token>"

1 {
2   "data": [
3     {
4       "id": "string",
5       "first_name": "string",
6       "last_name": "string",
7       "participant_number": "string",
8       "email": "string",
9       "state": "string"
10     }
11   ],
12   "pagination": {
13     "limit": 1,
14     "offset": 1,
15     "total": 1,
16     "has_more": true
17   }
18 }

Paginated list of participants for the plan manager. Requires X-Plan-Manager-Id header.

Was this page helpful?

Create participant

Authentication

AuthorizationBearer

API key issued for your account. Send as Bearer token in the Authorization header.

X-Plan-Manager-Idstring

Plan manager UUID. Required on all public API requests to scope data access.

Query parameters

limitintegerOptional1-100Defaults to 20

Items per page

offsetintegerOptional>=0Defaults to 0

Number of items to skip

Response

List of participants

datalist of objects

paginationobject

Errors

400

Bad Request Error

403

Forbidden Error

500

Internal Server Error