Skip to main content
GET
curl

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Successful get goal.

Stored singleton, or an object whose every serializer field is null before creation.

id
string<uuid>
required
read-only

Unique identifier of this resource. Returned by the server; not writable.

created_at
string<date-time>
required
read-only

Created at timestamp in ISO 8601 format. Returned by the server; not writable.

updated_at
string<date-time>
required
read-only

Updated at timestamp in ISO 8601 format. Returned by the server; not writable.

target_weight_kg
number<double> | null

Target body weight in kilograms. May be null when unavailable.

Required range: 20 <= x <= 400
starting_weight_kg
number<double> | null

Starting body weight in kilograms. May be null when unavailable.

Required range: 20 <= x <= 400
target_date
string<date> | null

Target date as an ISO 8601 calendar date. May be null when unavailable.