Retrieve a care goal

get/v1/care-goals/{id}

Returns one care goal by ID.

Authorization

Authorization: Bearer ak_...requiredscope: read

An AveeCare API key created in Settings → API Keys. A read or read + write key can call this endpoint. About authentication

stringrequired

ID of the care goal.

200

The care goal.

object

stringread-only

String representing the object's type. Always care_goal.

stringread-only

Unique identifier of the care goal.

patientId

string | nullmax length 64

The patient this goal is for.

name

string | nullmax length 200

Short name of the goal.

description

string | nullmax length 20000

What success looks like.

createdAt

string · date-time | nullread-only

When the care goal was created.

updatedAt

string · date-time | nullread-only

When the care goal was last changed.

Request-IdstringUnique ID of this request. Quote it when contacting support.

RateLimit-LimitintegerRequests allowed in the current window.

RateLimit-RemainingintegerRequests left in the current window.

RateLimit-ResetintegerSeconds until the window resets.

Status	Code	Meaning
401	n/a	The API key is missing, malformed, expired or revoked (`unauthorized`).
403	n/a	The key is read-only (`insufficient_scope`), or its user's role cannot do this (`forbidden`).
404	n/a	No such object, or it is not visible to this key (`not_found`).
429	n/a	Too many requests (`rate_limited`). Wait for `Retry-After` seconds.
500	n/a	Something went wrong on our side (`internal_error`). Retry, and quote the request ID if it persists.

Every error uses the same body. See Errors for the full list of codes.