Get Booking Link

Request

Get a booking link and its fields.

Security

apiKeyAuth and practiceGroupId

Path

idstringrequired

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

Responses

Ok

Bodyapplication/json

idstring^\d+$required

practice_group_idstring or null

short_linkstring or null

activeboolean

Default:false

expiry_datestring or null, (date-time)

maximum_usesnumberrequired

number_of_usesnumberrequired

open_countnumberrequired

unlimited_usebooleanrequired

metaobjectrequired

created_atstring or null, (date-time)

link_namestring or null

patient_idstring or null^\d+$

Response

{
  "id": "string",
  "practice_group_id": "string",
  "short_link": "string",
  "active": false,
  "expiry_date": "2019-08-24T14:15:22Z",
  "maximum_uses": 0,
  "number_of_uses": 0,
  "open_count": 0,
  "unlimited_use": true,
  "meta": {
    "appointment_type_id": [ … ],
    "location_id": [ … ],
    "practitioner_id": [ … ],
    "from_date": "2019-08-24T14:15:22Z",
    "to_date": "2019-08-24T14:15:22Z"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "link_name": "string",
  "patient_id": "string"
}

Get Booking Link

Request

Path

Responses

Was this page helpful?