This endpoint returns a list of profiles linked to a healer account
Endpoint URL:
https://api.ornament.health/accounting-api/public/v1.0/healer/linked-profiles
HTTP Method:
GET
Parameters
Obligatory
- None
Response Structure
The response is a JSON file that contains one or multiple objects, each representing a linked profile.
Response Object Attributes
| Attribute | Type | Description |
|---|---|---|
| pid | string | PID of the linked profile. |
| ssoId | string | Unique identifier of an account, used universally throughout the Ornament system. |
| createdAt | integer | Profile creation date in Unix timestamp format. |
| name | string | Name from the profile properties. |
| sex | string | User’s biological sex (M or F). |
| birthday | string | User’s birth date in YYYY-MM-DD format. |
| lastSubmissionsUpdate | integer | Last submissions update date in Unix timestamp format. |
| isTransferred | boolean | Relevant only to Ornament Pro site. |
| isArchived | boolean | Relevant only to Ornament Pro site. |
| isFavorite | boolean | Relevant only to Ornament Pro site. |
| isDemoPatient | boolean | true if the PID is a demo patient automatically created when a physician registers at Ornament Pro. false for all other patients. |
Sample Response
[
{
"pid": "0016863d-402c-4a03-9b06-7b6f41310add",
"ssoId": "f9c7fef7-1120-4c9b-b853-978eee3c3637",
"createdAt": 1740678724,
"name": "Patient 1",
"sex": "M",
"birthday": "1990-09-04",
"lastSubmissionsUpdate": 1740739547,
"isTransferred": false,
"isArchived": false,
"isFavorite": false,
"isDemoPatient": false
},
{
"pid": "038473b2-bf05-4f86-8e30-7232bc1ce5d4",
"ssoId": "4c56c4e6-ed01-428d-998f-3c2ce35babb3",
"createdAt": 1739971248,
"name": "Patient 2",
"sex": "M",
"birthday": "1990-09-04",
"isTransferred": false,
"isArchived": false,
"isFavorite": false,
"isDemoPatient": false
}
]
