Retrieve a guest form

GET https://api.zenoti.com/v1/Guests/{guest_id}/Forms

This API helps you to retrieve the specified guest's form data.You must specify the unique identifier of the guest as guest_id and the form's version_no in the API request.Note: Retrieving uploaded files, signatures and annoations are not supported.

Before you begin

Permission: Manage API Keys (on the Administrator security object) — Required to access Zenoti APIs.

Endpoint

GET /v1/Guests/{guest_id}/Forms

Base URL: https://api.zenoti.com

Request

Headers

Header Required Description
Authorization Yes bearer {{access_token}}

Path parameters

Parameter Type Required Description
guest_id string Yes Mandatory Unique 32-character identifier of the guest.

Query parameters

Parameter Type Required Default Description
version_no string Yes — Mandatory Unique 32-character identifier of the guest's form's version number.

Response

Success (200 OK)

{
  "data": "[{\"name\":\"name\",\"value\":\"[GuestName]\"},{\"name\":\"datebirth\",\"value\":\"[GuestDob]\"},{\"name\":\"ZipCode\",\"value\":\"89109\"},{\"name\":\"Address\",\"value\":\"1465 Westwood Blvd\\r\\nCalip\"},{\"name\":\"homephone\",\"value\":\"\"},{\"name\":\"Cell\",\"value\":\"\"},{\"name\":\"Email\",\"value\":\"appointments@beautyspa.com\"},{\"name\":\"EmergencyContact\",\"value\":\"\"},{\"name\":\"EmergencyContactPhone\",\"value\":\"\"},{\"name\":\"Occupation\",\"value\":\"\"},{\"name\":\"HavingMassage\",\"value\":\"HavingMassage\"},{\"name\":\"Cancer\",\"value\":\"Cancer\"},{\"name\":\"Swellingwhereinput\",\"value\":\"\"},{\"name\":\"Pregnanthowmanyinput\",\"value\":\"\"},{\"name\":\"checkedconditio\",\"value\":\"\"},{\"name\":\"checkemedications\",\"value\":\"\"},{\"name\":\"minorNameBottom1\",\"value\":\"\"},{\"name\":\"dateminorDate1\",\"value\":\"[AppointmentStarttime]\"},{\"name\":\"patientNameBottom21\",\"value\":\"[GuestName]\"},{\"name\":\"datepatientDate21\",\"value\":\"[AppointmentStarttime]\"},{\"name\":\"theripastNameBottom31\",\"value\":\"[TherapistName]\"},{\"name\":\"datetheripastDate31\",\"value\":\"[AppointmentStarttime]\"},{\"name\":\"caredermatologist\",\"value\":\"\"},{\"name\":\"undergonesurgeries\",\"value\":\"\"},{\"name\":\"healthproblems\",\"value\":\"Yes\"},{\"name\":\"HavingFacial\",\"value\":\"\"},{\"name\":\"HavingSuna\",\"value\":\"\"},{\"name\":\"MinorConsent\",\"value\":\"\"},{\"name\":\"ContagiousSkinC\",\"value\":\"\"},{\"name\":\"OpenSoresorWoun\",\"value\":\"\"},{\"name\":\"EasyBruising\",\"value\":\"\"},{\"name\":\"RecentAccidentI\",\"value\":\"\"},{\"name\":\"RecentFracture\",\"value\":\"\"},{\"name\":\"RecentSurgery\",\"value\":\"\"},{\"name\":\"JointReplacemen\",\"value\":\"\"},{\"name\":\"SprainsStrains\",\"value\":\"\"},{\"name\":\"CurrentFeverChi\",\"value\":\"\"},{\"name\":\"SwollenGlands\",\"value\":\"\"},{\"name\":\"AllergiesSensit\",\"value\":\"\"},{\"name\":\"HeartCondition\",\"value\":\"\"},{\"name\":\"Pacemaker\",\"value\":\"\"},{\"name\":\"HighLowBloodPre\",\"value\":\"\"},{\"name\":\"CirculatoryDiso\",\"value\":\"\"},{\"name\":\"VaricoseVeins\",\"value\":\"\"},{\"name\":\"Atherosclerosis\",\"value\":\"\"},{\"name\":\"Phlebitis\",\"value\":\"\"},{\"name\":\"BloodClotsJoint\",\"value\":\"\"},{\"name\":\"Osteoporosis\",\"value\":\"\"},{\"name\":\"Epilepsy\",\"value\":\"\"},{\"name\":\"HeadachesMigrai\",\"value\":\"\"},{\"name\":\"Diabetes\",\"value\":\"\"},{\"name\":\"Numbness\",\"value\":\"\"},{\"name\":\"BackNeckIssues\",\"value\":\"\"},{\"name\":\"Fibromyalgia\",\"value\":\"\"},{\"name\":\"TMJ\",\"value\":\"\"},{\"name\":\"CarpalTunnel\",\"value\":\"\"},{\"name\":\"TennisElbow\",\"value\":\"\"},{\"name\":\"FrozenShoulder\",\"value\":\"\"},{\"name\":\"Swellingwhere\",\"value\":\"\"},{\"name\":\"Pregnanthowmany\",\"value\":\"\"},{\"name\":\"idconsent4\",\"value\":\"\"},{\"name\":\"idconsent5\",\"value\":\"\"},{\"name\":\"idconsent6\",\"value\":\"\"},{\"name\":\"dermatologist\",\"value\":\"\"},{\"name\":\"surgeries\",\"value\":\"\"},{\"name\":\"one-signature\",\"value\":[]}]",
  "guest_data": "[]",
  "is_form_submitted": true
}

Response fields

Field Type Description
data string
guest_data string
is_form_submitted boolean

Example

curl --request GET \
  --url 'https://api.zenoti.com/v1/Guests/{guest_id}/Forms?version_no={{version_no}}' \
  --header 'Authorization: bearer {{access_token}}'
const response = await fetch('https://api.zenoti.com/v1/Guests/{guest_id}/Forms', {
  method: 'GET',
  headers: {
    'Authorization': 'bearer {{access_token}}'
  },
});
const data = await response.json();
import requests

response = requests.get(
    'https://api.zenoti.com/v1/Guests/{guest_id}/Forms',
    headers={
        'Authorization': 'bearer {{access_token}}',
    },
)
data = response.json()
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "bearer {{access_token}}");
var response = await client.GetAsync(
    "https://api.zenoti.com/v1/Guests/{guest_id}/Forms");
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'

uri = URI('https://api.zenoti.com/v1/Guests/{guest_id}/Forms')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Authorization'] = 'bearer {{access_token}}'
response = http.request(request)
data = JSON.parse(response.body)

Error codes

Status Description
400 400
401 Unauthorized -- invalid or expired access token
429 Too many requests -- rate limit exceeded