Intake Link

The GET intake link method allows for an external vendor to retrieve the Intelligent Intake link associated with a specific patient's appointment. Given an appointmentId, the service will return a URL that is intended to be used by the patient in order to complete the assigned Intelligent Intake, typically prior to the scheduled appointment.


Given the nature of Intelligent Intake and the Intake Link functionality, there are configuration prerequisites in order to ensure Intake Links are being generated for appointments:

Authentication & Headers

See Access to RESTful Webservices
Header =  'X-Api-Key: {apiKey}'

Endpoint Information

HTTP Method: GET


NameData TypeLocationRequiredDescription
appointmentIdinteger ($int32)pathYesIdentifier of an existing patient appointment

Sample Request

curl -X 'GET' \
  '{appointmentId}' \
  -H 'accept: text/plain' \
  -H 'X-Api-Key: {apiKey}'

Sample Response Body

  "success": true,
  "data": {
    "intakeLinkUrl": ""
  } }