Skip to main content

Get all user consents

MethodPath
GET/v1/slim/user/consents

Authentication · Access policies

Returns every consent of the signed-in practitioner in one response. Use it at sign-in to decide which consent prompts to show.

Auth: Bearer token for a practitioner session (the profile must be a Practitioner). The caller's access policy must grant Consent:read and Consent:search (project admins skip this check). Scope: The caller's practitioner profile in the caller's project (from the token).

Behaviour​

  • Both medicalSettingsNotificationsConsent and termsAndConditionsConsent are versioned. Each is true only when an acceptance is on file and either matches the currently published version of that consent or no version has been published yet.
  • Publishing a new version of a consent turns it false for everyone until they accept again.
  • The published version is the one of the root project of your project tree. Without one, the platform-wide version applies.
  • A consent with no record reads false.

Example​

curl -X GET 'https://api.sandbox.ovok.com/v1/slim/user/consents' \
-H "Authorization: Bearer ${OVOK_TOKEN}"
FieldTypeMeaning
medicalSettingsNotificationsConsentbooleanWhether the practitioner has accepted the current medical settings and notifications consent.
termsAndConditionsConsentbooleanWhether the practitioner has accepted the current terms and conditions.

Successful response​

200 — Consent statuses retrieved successfully.

Errors​

StatusMeaning
401The bearer token is missing or invalid.
403The session is not a practitioner session, has no project, or its access policy lacks Consent:read or Consent:search.