API Reference
  1. Viv Public API
  2. Care Tasks

List care tasks

get
https://{apiHost}/api/v2/public/care-tasks

Retrieve a paginated list of per-client care plan tasks (ClientTask2).

Geo-restricted API keys must pass clientId. Without it the query
would fan out across every client in every allowed geo and hit an
in-memory sort that fails past 100MB at production scale. Cross-geo
clientId (the client lives in a geo the key isn't scoped to) returns
404 CLIENT_NOT_FOUND for parity with every other endpoint on this
surface. bookingTypeId also requires clientId so the filter stays
index-served.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
1 to 100
Defaults to 20

Maximum number of results to return (1-100)

integer
≥ 0
Defaults to 0

Number of results to skip for pagination

string

Filter by client ID

string

Filter by geo ID

string
enum

Filter by task type

Allowed:
string

Filter by category

string

Search by task name

boolean
Defaults to false

Include deleted tasks

string

Filter by booking type

Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?