Sign in

v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Retrieve a list of all the Guest Pass users

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.

get/v1/guests/{guest_id}/guestpass?instrument_id={instrument_id}&instrument_type={instrument_type}&list_type={list_type}&credit_type={credit_type}

Path parameters

guest_idstring required

Unique identifier of the guest.

Query parameters

instrument_idstring

(Optional) Unique identifier of the item

instrument_typeinteger

(Optional) The type of the item. Default - 1: Membership

list_type'0' | '1' | '2'

(Optional) Type of the user list as requesting in the API. Values - 0: Both, 1: Receiver, 2:Sender Receiver : From whom the above user received the item_type. Sender: To whom the above user sent the item_type

credit_type'0' | '1' | '2'

(Optional) Credit type of the Guest Pass.1: Classes, 2: Visits, 0: Both

Response

200

OR
OR
OR

Example response

{
  "guestpass": [
    {
      "user": {
        "first_name": "API",
        "last_name": "User01"
      },
      "code": "1111000000001",
      "instrument_id": "53660394-dfca-494e-b9e6-59896e716b6a",
      "instrument_type": "Membership",
      "user_type": "Receiver",
      "credit_type": "Classes",
      "status": "Activated",
      "created_date": "2022-03-25T12:20:45.117"
    }
  ]
}