Get Practice Group

Request

Retrieves information regarding the authenticated Practice Group.

Security

apiKeyAuth and practiceGroupId

curl -i -X GET \
  https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/me \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json

idstringrequired

namestringrequired

sectorstringrequired

Enum:"nhs""paid"

ods_codestring or nullrequired

write_to_recordbooleanrequired

ehr_partnerstring or nullrequired

Enum:"emis""systm_one"

ehr_partner_enabledbooleanrequired

custom_slot_to_slotbooleanrequired

use_partner_bookable_slotsbooleanrequired

data_source_prioritiesArray of stringsrequired

Items Enum:"hero""emis""pds""gha""systm_one"

time_zonestringrequired

IANA time zone the practice group operates in, eg Europe/London. Defaults to Europe/London where the practice group has none set.

js_booking_servicebooleanrequired

prescription_partner_enabledbooleanrequired

prescription_partnerstring or nullrequired

Enum:"signature_rx""chem4u""pharmacierge"

prescription_partner_credentialsobject or null

addressobject or nullrequired

authenticated_asobject or nullrequired

ehr_healthyboolean

Response

{
  "id": "string",
  "name": "string",
  "sector": "nhs",
  "ods_code": "string",
  "write_to_record": true,
  "ehr_partner": "emis",
  "ehr_partner_enabled": true,
  "custom_slot_to_slot": true,
  "use_partner_bookable_slots": true,
  "data_source_priorities": [
    "hero"
  ],
  "time_zone": "string",
  "js_booking_service": true,
  "prescription_partner_enabled": true,
  "prescription_partner": "signature_rx",
  "prescription_partner_credentials": {
    "email": "string"
  },
  "address": {
    "line_1": "string",
    "postcode": "string",
    "line_2": "string",
    "line_3": "string",
    "town": "string",
    "county": "string",
    "country": "string"
  },
  "authenticated_as": {
    "id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "external_prescriber_id": "string",
    "signature": "string",
    "linked_practitioner_id": "string",
    "preferences": { … },
    "team_memberships": [ … ],
    "role": { … },
    "policies": [ … ],
    "revoked_policies": [ … ]
  },
  "ehr_healthy": true
}