API ReferenceapiclinicalGET /v1/check-ins/next

GET /v1/check-ins/next

Service: clinical · operationId: (none)

Calculate the next due 30/60/90 day check-in for the authenticated patient

Required scopes

(no scope declared — review service config)

Query parameters

  • enrolled_at (string) required

Responses

200 Next due check-in day marker, or null if all are complete

{
  "type": "object",
  "properties": {
    "day_marker": {
      "anyOf": [
        {
          "type": "number",
          "enum": [
            30
          ]
        },
        {
          "type": "number",
          "enum": [
            60
          ]
        },
        {
          "type": "number",
          "enum": [
            90
          ]
        },
        {
          "type": "null"
        }
      ]
    },
    "due_at": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": [
    "day_marker",
    "due_at"
  ]
}

500 Internal error

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "error",
    "message"
  ]
}

Example

curl -X GET https://clinical.platform.loop.health/v1/check-ins/next \
  -H "Authorization: Bearer $ACCESS_TOKEN"