Retrieve a list of all the guest passes sent from or received by a user
gethttps://api.zenoti.com/v1/guests//guestpass
The purpose of this API is to retrieve a list of all the guest passes sent from or received by a user. This includes Used, Received, and Available guest passes. You must specify the unique identifier of the guest who is sharing the guest pass guest_id, the item id for which the user wants to transfer to/receive from (default value would be null) instrument_id, the item type (default would be 1. 1: Membership) instrument_type, guest pass credit type (default would be 1. 1: Classes, 2: Visits, 0: Both) credit_type, type of user list the user requested (default would be 0. 0: Both, 1: Receiver, 2:Sender) list_type, and the expand parameter (expand[0]=available, expand[1]=received, expand[2]=used) expand.
Response object
GuestPassResponse
Json property
Data type
Description
guestpass
List
Received guest passes
available
List
Available Guest Passes
received
List
Received Guest Passes
used
List
Used Guest Passes
error
APIV2GuestPassErrorModel
API error object
GuestPassUserData
Json property
Data type
Description
user
GuestPassUser
Barcode
code
String
Barcode
instrument_id
String
Barcode
instrument_type
String
Barcode
user_type
string
User Type
credit_type
string
Guest pass type
status
string
Guest pass status
created_date
DateTime
Guest pass created date
instrument_name
string
Instrument Name
guest_pass_type
GuestPassCreditType
Guest Pass Credit Type
expiration_date
DateTime?
Expiration date
AvailableGuestPassesModel
Json property
Data type
Description
instrument_name
string
Instrument Name
available
int
Number of available guest passes
total
int
Total number of GuestPasses
start_date
DateTime?
Start date for redemption
expiration_date
DateTime?
Expiration date
guest_pass_type
GuestPassCreditType
Guest Pass Credit Type
ReceivedGuestPassesModel
Json property
Data type
Description
guest_pass_code
string
Guest Pass Name
received_date
DateTime?
Received date
received_from
string
Received From
instrument_type
String
Instrument type
instrument_name
string
Instrument Name
instrument_id
string
Instrument Id
expiration_date
DateTime?
Expiration date
status
String
Status (Active/Inactive)
credit_type
String
Status
guest_pass_type
GuestPassCreditType
Guest Pass Credit Type
UsedGuestPassesModel
Json property
Data type
Description
guest_pass_code
string
Guest Pass Code
instrument_type
String
Instrument Type
instrument_name
string
Instrument Name
instrument_id
string
Instrument Id
redemption_date
DateTime?
Redemption date
invoice_number
string
Invoice Number
class_name
string
Class Name
instructor_name
string
Instructor Name
center
string
Redemption Center
status
String
Status
credit_type
String
Status
guest_pass_type
GuestPassCreditType
Guest Pass Credit Type
Language
Credentials
Header
Click Try It! to start a request and see the response here!