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 Invoice View Sessions

List invoice view sessions

GET

https://api.caresquareapi.com/api/public/v1/invoice-view-sessions

GET

/api/public/v1/invoice-view-sessions

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

1 {
2   "data": [
3     {
4       "id": "string",
5       "invoice_id": "string",
6       "user_id": "string",
7       "user_name": "string",
8       "session_started": "2024-01-15T09:30:00Z",
9       "session_ended": "2024-01-15T09:30:00Z",
10       "last_heartbeat": "2024-01-15T09:30:00Z",
11       "duration_seconds": 1,
12       "created_at": "2024-01-15T09:30:00Z",
13       "active_duration_seconds": 1,
14       "engaged_duration_seconds": 1,
15       "idle_count": 1
16     }
17   ],
18   "pagination": {
19     "limit": 1,
20     "offset": 1,
21     "total": 1,
22     "has_more": true
23   }
24 }

Paginated list of invoice view sessions for the plan manager. Requires X-Plan-Manager-Id header.

Was this page helpful?

Get invoice view session by ID

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 invoice view sessions

datalist of objects

paginationobject

Errors

400

Bad Request Error

403

Forbidden Error

500

Internal Server Error