API Reference
  1. Viv Public API
  2. Clients

List client careplan goals

get
https://{apiHost}/api/v2/public/clients//goals

Retrieve all careplan goals for a client. Goals track client care objectives
with status tracking (UPCOMING, IN_PROGRESS, OVERDUE, MET, NOT_MET).
Supports filtering by title search and status, with pagination.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique client identifier

Query Params
string

Filter goals by title (case-insensitive partial match)

string
enum

Filter by goal status

Allowed:
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

Responses

Updated 4 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 4 months ago

Did this page help you?