Get Profile

GET

api

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",
  "transactional_emails_enabled": true,
  "created_at": "2026-04-01T09:14:32Z",
  "updated_at": "2026-04-01T11:05:00Z"
}

{
  "error": "Invalid profile ID format"
}

{
  "error": "Profile not found"
}

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.

Request

Path parameters

string

required

Unique identifier (UUID) of the profile to retrieve.

Response

On success, the API returns 200 OK with the profile.

string

required

Unique profile identifier (UUID).

string

Profile handle or username. May be null.

string

First name. May be null.

string

Last name. May be null.

string

Email address. May be null.

string

Phone number in E.164 format. May be null.

integer

Biological sex per ISO/IEC 5218 (0 = unknown, 1 = male, 2 = female). May be null.

string

Date of birth in YYYY-MM-DD format. May be null.

number

Height in centimeters. May be null.

number

Weight in kilograms. May be null.

string

Preferred language (en, de, or fi).

boolean

Whether this profile receives transactional (programmatic) emails. null when never set.

string

ISO 8601 timestamp of when the profile was created.

string

ISO 8601 timestamp of the last update. May be null.

Error responses

Status	Description
`400`	Invalid ID format — the provided value is not a valid UUID.
`403`	Forbidden — your API key does not have access to this operation or the profile is outside your access context.
`404`	Profile not found.
`500`	Internal 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",
  "transactional_emails_enabled": true,
  "created_at": "2026-04-01T09:14:32Z",
  "updated_at": "2026-04-01T11:05:00Z"
}

{
  "error": "Invalid profile ID format"
}

{
  "error": "Profile not found"
}

Create Profile

Update Profile

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",
  "transactional_emails_enabled": true,
  "created_at": "2026-04-01T09:14:32Z",
  "updated_at": "2026-04-01T11:05:00Z"
}

{
  "error": "Invalid profile ID format"
}

{
  "error": "Profile not found"
}

Health

Profiles

Appointments

Home Kit Orders

Biomarkers

Panels

Units

Locations

Documents

Shipments

Request

Path parameters

Response

Error responses

​Request

​Path parameters

​Response

​Error responses

Request

Path parameters

Response

Error responses