Widget

Lookup a client by email or phone (for existing client booking flow)

Changed on
post/public/widget/clients/lookup

Request

Request body

sessionIdstring required

The widget session — must have completed OTP for the email being looked up (ITE-434).

clinicIdstring required
emailstring nullable
phonestring nullable

Response

OK

foundboolean
clientIdstring nullable
clientNamestring nullable
clientEmailstring nullable
clientPhonestring nullable

Example response

{
  "patients": [
    {
      "species": "Cat",
      "breed": "Siamese",
      "sex": "Male"
    }
  ]
}

Changes

    • breaking

      added the new required request property (media type: application/json)

    • breaking

      added the new required request property (media type: text/json)

    • breaking

      added the new required request property (media type: application/*+json)