Retrieve a list of all the guest passes sent from or received by a user

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 propertyData typeDescription
guestpassListReceived guest passes
availableListAvailable Guest Passes
receivedListReceived Guest Passes
usedListUsed Guest Passes
errorAPIV2GuestPassErrorModelAPI error object

GuestPassUserData

Json propertyData typeDescription
userGuestPassUserBarcode
codeStringBarcode
instrument_idStringBarcode
instrument_typeStringBarcode
user_typestringUser Type
credit_typestringGuest pass type
statusstringGuest pass status
created_dateDateTimeGuest pass created date
instrument_namestringInstrument Name
guest_pass_typeGuestPassCreditTypeGuest Pass Credit Type
expiration_dateDateTime?Expiration date

AvailableGuestPassesModel

Json propertyData typeDescription
instrument_namestringInstrument Name
availableintNumber of available guest passes
totalintTotal number of GuestPasses
start_dateDateTime?Start date for redemption
expiration_dateDateTime?Expiration date
guest_pass_typeGuestPassCreditTypeGuest Pass Credit Type

ReceivedGuestPassesModel

Json propertyData typeDescription
guest_pass_codestringGuest Pass Name
received_dateDateTime?Received date
received_fromstringReceived From
instrument_typeStringInstrument type
instrument_namestringInstrument Name
instrument_idstringInstrument Id
expiration_dateDateTime?Expiration date
statusStringStatus (Active/Inactive)
credit_typeStringStatus
guest_pass_typeGuestPassCreditTypeGuest Pass Credit Type

UsedGuestPassesModel

Json propertyData typeDescription
guest_pass_codestringGuest Pass Code
instrument_typeStringInstrument Type
instrument_namestringInstrument Name
instrument_idstringInstrument Id
redemption_dateDateTime?Redemption date
invoice_numberstringInvoice Number
class_namestringClass Name
instructor_namestringInstructor Name
centerstringRedemption Center
statusStringStatus
credit_typeStringStatus
guest_pass_typeGuestPassCreditTypeGuest Pass Credit Type
Language
Credentials
Header
Click Try It! to start a request and see the response here!