TWtwinehealth
health profile

List health profiles

Changed on

Get a list of health profiles

get/health_profile

Request

  • Base URL
    https://api.twinehealth.com/pub
  • Auth
    none declared

Query parameters

filter[patient]string

Patient id to fetch health profile. Note that one of the following filters must be specified: filter[patient], filter[group], or filter[organization].

filter[groups]string

Comma-separated list of group ids. Note that one of the following filters must be specified: filter[patient], filter[group], or filter[organization].

filter[organization]string

Fitbit Plus organization id. Note that one of the following filters must be specified: filter[patient], filter[group], or filter[organization].

page[number]integer

Page number

page[size]integer

Page size

page[limit]integer

Page limit

page[cursor]string

Page cursor

include'patient' | 'questions'

List of related resources to include in the response

Response

OK

Example response

{
  "data": [
    {
      "type": "health_profile",
      "id": "59d441ac21741161bbe266b5",
      "attributes": {
        "created_at": "2017-07-07T19:15:56.229Z",
        "stats": [
          {
            "category": "lifestyle_behaviors",
            "answered": 5,
            "total": 11
          },
          {
            "category": "mental_wellbeing",
            "answered": 3,
            "total": 5
          },
          {
            "category": "preventative_care",
            "answered": 1,
            "total": 3
          },
          {
            "category": "overall",
            "answered": 9,
            "total": 19
          }
        ],
        "updated_at": "2017-07-07T19:15:56.229Z"
      },
      "relationships": {
        "patient": {
          "data": {
            "id": "595fddea28c5041b84466bbe",
            "type": "patient"
          },
          "links": {
            "related": "/pub/health_profile/59d441ac21741161bbe266b5/patient"
          }
        },
        "questions": {
          "data": [
            {
              "id": "595fddea28c5041b84466bbe",
              "type": "health_profile_question"
            }
          ],
          "links": {
            "related": "/pub/health_profile/59d441ac21741161bbe266b5/questions"
          }
        }
      },
      "links": {
        "self": "/pub/health_profile/59d441ac21741161bbe266b5"
      }
    }
  ]
}

Changes