Skip to main content
GET
/
user
/
patient
/
{patient_id}
/
tags
Get Patient Tags For Patient
curl --request GET \
  --url https://api.decodahealth.com/user/patient/{patient_id}/tags \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "isActive": true,
    "createdDate": "2023-11-07T05:31:56Z",
    "emoji": "<string>",
    "color": "<string>",
    "updatedDate": "2023-11-07T05:31:56Z"
  }
]

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

patient_id
string
required

Response

Successful Response

id
string
required

Unique identifier for the patient tag

name
string
required

Name of the patient tag

isActive
boolean
required

Whether the tag is active

createdDate
string<date-time>
required

Date and time when the tag was created

emoji
string | null

Emoji associated with the tag

color
string | null

Color code for the tag (hex format)

updatedDate
string<date-time> | null

Date and time when the tag was last updated