Get a specific checkin

Request

Retrieves detailed information about a specific checkin by its UUID

Path

idstringrequired

Checkin UUID

GET

/rest/v2/checkins/{id}

curl -i -X GET \
  'https://api.rhythms.ai/rest/v2/checkins/{id}'

Responses

Success

Headers

any

Body*/*

uuidstringrequired

Uuid

goal_uuidstringrequired

Goal uuid

metric_uuidstring

Metric uuid

Default:null

valuenumber

Value

Default:null

progressnumber

Progress

Default:null

scorenumber

Score

Default:null

checkin_datestringrequired

Checkin date

statusstring

Status

Default:"not_started"

notestring

Note

Default:null

creator_uuidstringrequired

Creator uuid

source_infoobjectrequired

Source info

Default:"{}"

mentioned_entitiesobjectrequired

Mentioned entities

Default:"[]"

Response

{
  "uuid": "string",
  "goal_uuid": "string",
  "metric_uuid": null,
  "value": null,
  "progress": null,
  "score": null,
  "checkin_date": "string",
  "status": "not_started",
  "note": null,
  "creator_uuid": "string",
  "source_info": "{}",
  "mentioned_entities": "[]"
}