Skip to content
API Docs/
API Reference
/
/
Get Link Status

Get Link Status

Request

Get the status of a given link.

Security
apiKeyAuth and practiceGroupId
Query
urlstring

The URL of the link. Provide either 'url' or 'id'.

Example:url=https://bookings.herohealth.net/s/abc123
idstring

The ID of the short link. Provide either 'url' or 'id'.

Example:id=12345
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/links/status?url=https%3A%2F%2Fbookings.herohealth.net%2Fs%2Fabc123&id=12345' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
statusstringrequired
Enum:"unused""used""partially_used""expired""disabled"
typestringrequired
Enum:"booking""questionnaire""attachment""patient_reply""video"
referenceArray of objects
Response
{
  "status": "unused",
  "type": "booking",
  "reference": [
    { … }
  ]
}