Get the consultation form link for an appointment

Get the link to the consultation forms the client still has to fill in for the visit this appointment belongs to. This is the same link Phorest sends to the client by SMS or email before their visit, so you can send it through your own channels, for example WhatsApp. A visit is all of the client's appointments at the branch on the same day, so those appointments share one link. The link is only returned while the client has forms to fill in, that is, a required form that hasn't been started or is still a draft. When there is nothing to fill in, the response has no link and no expiresAt. The link stops working at expiresAt, the start of the day after the visit in the branch's timezone. A link is still returned for past visits, so check expiresAt before sending it. Completed forms are saved to the client's record in Phorest automatically. If you send this link yourself, consider turning off Phorest's own pre-visit consultation message for the branch so the client doesn't receive it twice. Returns 404 with errorCode CONSULTATION_LINK_NOT_AVAILABLE when the appointment has no consultation visit, for example because the business doesn't use consultations, or the appointment is reserved, cancelled, archived or on the waiting list.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json