v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Search for a guest

This API helps you to search for a guest in the specified center or in the whole organization based on the Zenoti org level setting "Search Guest Across Centers".

get/v1/guests/search?center_id={center_id}&first_name={first_name}&last_name={last_name}&zip_code={zip_code}&phone={phone}&tags={tags}&user_name={user_name}&user_code={user_code}&email={user_email}

Query parameters

center_idstring

Unique 32-character identifier of the center.

zip_codestring

Optional Zip code of the guest's address.

pageinteger

Optional Number of the display page. Default value is 1.

sizeinteger

Optional Number of records per page. Default value is 10.

user_namestring

Optional Username of the guest

user_codestring

Optional User code of the guest

phonestring

Optional Phone number of the guest

emailstring

Optional Email ID of the guest

first_namestring

Optional First name of the guest

last_namestring

Optional Last name of the guest

tagsstring

Optional Any tags associated with a guest

Response

200

Example response

{
  "guests": [
    {
      "id": "A9996495-6BCD-415A-ADB1-052353D9EF9F",
      "center_id": "b5ed4fbb-4c05-4195-b313-1320b620224b",
      "personal_info": {
        "user_name": "simonsimu",
        "first_name": "simon",
        "last_name": "simon",
        "middle_name": "simon",
        "email": "simon@simon.com",
        "mobile_phone": {
          "country_code": 95,
          "number": "7777799988"
        },
        "work_phone": {
          "country_code": 95,
          "number": "7777799999"
        },
        "home_phone": {
          "country_code": 95,
          "number": "7777799999"
        },
        "gender": 1,
        "date_of_birth": "1997-08-02T00:00:00",
        "nationality_id": 95,
        "anniversary_date": "2018-11-06T00:00:00"
      },
      "address_info": {
        "address_1": "aaaaaaaaa",
        "address_2": "bbbbbbbbb",
        "city": "cccccccccc",
        "country_id": 95,
        "state_id": -2,
        "state_other": "mystate",
        "zip_code": "502032"
      },
      "preferences": {
        "receive_transactional_email": true,
        "receive_transactional_sms": true,
        "receive_marketing_email": true,
        "receive_marketing_sms": true,
        "recieve_lp_stmt": true,
        "preferred_therapist": {
          "id": "4a98db4c-8424-466e-97f8-2e54d529fdbd",
          "name": "New Delhi_mgr mgr"
        }
      },
      "tags": [
        "CHECKED_IN"
      ],
      "referral": {
        "referral_source": {
          "id": "57cdad4d-7045-40b3-885b-d0c191c75113",
          "name": "Guest"
        },
        "referred_by": {
          "id": "02be89a4-1250-45a6-80a1-34b286e68228",
          "name": "Kirity Newdelhi"
        }
      },
      "primary_employee": {
        "id": "4a98db4c-8424-466e-97f8-2e54d529fdbd",
        "name": "New Delhi_mgr mgr"
      }
    }
  ]
}