Skip to main content
GET
/
api
/
v1
/
profiles
/
{id}
curl --request GET \
  --url https://anivahealth.com/api/v1/profiles/a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d \
  --header 'x-api-key: YOUR_API_KEY'
{
  "id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
  "handle": null,
  "first_name": "Maria",
  "last_name": "Schmidt",
  "email": "maria.schmidt@example.com",
  "phone": "+4930123456789",
  "sex": 2,
  "date_of_birth": "1985-03-22",
  "height": 168,
  "weight": 65,
  "language": "de",
  "created_at": "2026-04-01T09:14:32Z",
  "updated_at": "2026-04-01T11:05:00Z"
}
Retrieve a single patient profile by its UUID. Use this endpoint to look up demographic data or verify that a profile exists before scheduling an appointment.
Requires the PROFILES_VIEW or IMPERSONATE scope. Requests made with a key that lacks both scopes return 403 Forbidden.

Request

Path parameters

id
string
required
Unique identifier (UUID) of the profile to retrieve.

Response

On success, the API returns 200 OK with the profile.
id
string
required
Unique profile identifier (UUID).
handle
string
Profile handle or username. May be null.
first_name
string
First name. May be null.
last_name
string
Last name. May be null.
email
string
Email address. May be null.
phone
string
Phone number in E.164 format. May be null.
sex
integer
Biological sex per ISO/IEC 5218 (1 = male, 2 = female). May be null.
date_of_birth
string
Date of birth in YYYY-MM-DD format. May be null.
height
number
Height in centimeters. May be null.
weight
number
Weight in kilograms. May be null.
language
string
Preferred language (en, de, or fi).
created_at
string
ISO 8601 timestamp of when the profile was created.
updated_at
string
ISO 8601 timestamp of the last update. May be null.

Error responses

StatusDescription
400Invalid ID format — the provided value is not a valid UUID.
403Forbidden — missing PROFILES_VIEW or IMPERSONATE scope, or the profile is outside your access context.
404Profile not found.
500Internal server error.
curl --request GET \
  --url https://anivahealth.com/api/v1/profiles/a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d \
  --header 'x-api-key: YOUR_API_KEY'
{
  "id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
  "handle": null,
  "first_name": "Maria",
  "last_name": "Schmidt",
  "email": "maria.schmidt@example.com",
  "phone": "+4930123456789",
  "sex": 2,
  "date_of_birth": "1985-03-22",
  "height": 168,
  "weight": 65,
  "language": "de",
  "created_at": "2026-04-01T09:14:32Z",
  "updated_at": "2026-04-01T11:05:00Z"
}