get
https://api.zenoti.com/v1/guests//guestpass?instrument_id=&instrument_type=&list_type=&credit_type=
Purpose: Use this API to list all the users of the Guest Pass membership program.
You must specify guest_id to fetch the list of the guest pass users.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Response Details
| Name | Type | Description |
|---|---|---|
| guestpass | object | Object containing the details of the Guest Pass users. |
guestpass Object
| Name | Type | Description |
|---|---|---|
| user | object | Object containing the details of the Guest Pass users. |
user Object
| Name | Type | Description |
|---|---|---|
| code | id | Unique code of the guest. |
| instrument_id | guid | Unique identifier of the item. |
| instrument_type | string | Type of the liability item. Default: Membership |
| user_type | string | Type of the user in the list. |
| credit_type | string | Type of the Guest Pass credit. |
| status | string | Status of the guest |
| created_date | datetime | Time and date when the record was created. |
GuestPassUser Object
| Name | Type | Description |
|---|---|---|
| id | guid | Unique identifier of the guest. |
| first_name | string | First name of the Guest Pass user. |
| last_name | string | Last name of the Guest Pass user. |
error Object
| Code | Message | Description |
|---|---|---|
| GP001 | Guest pass is not enabled | When the Guest Pass membership is not enabled for the organization. |