Get a pass instance

GET /passes/{id}

Requires the passes:read permission.

Authorization

X-API-Key required

Parameters

Name	Location	Type	Required
id	path	string	Yes

Request Examples

curl -X GET "https://api.remypass.com/api/v1/public/passes/507f1f77bcf86cd799439011" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

Use Case Examples

Get pass instance by ID

curl -X GET https://api.remypass.com/api/v1/public/passes/507f1f77bcf86cd799439013 \
  -H "X-API-Key: YOUR_API_KEY"

Responses

Status	Description
200	Pass instance retrieved.
400	Bad request. The top-level message explains what is invalid and, where applicable, the errors array contains structured field details.
401	Missing or invalid API key.
403	The caller is not allowed to access this resource.
404	Resource not found.
429	Rate limit exceeded.
500	Server error.

200 Response Example

{
  "success": true,
  "message": "string",
  "data": {
    "_id": "507f1f77bcf86cd799439013",
    "serialNumber": "string",
    "status": "active",
    "member": "string",
    "pass": "string",
    "recipientName": "string",
    "recipientEmail": "user@example.com",
    "expiryDate": "2026-01-01T12:00:00.000Z",
    "issuedAt": "2026-01-01T12:00:00.000Z",
    "walletUrls": {
      "apple": "string",
      "google": "string"
    },
    "maxUses": 1,
    "usesRemaining": 1,
    "redeemedCount": 1,
    "lastRedeemedAt": "2026-01-01T12:00:00.000Z",
    "passType": "generic",
    "customFields": {},
    "eventTime": "2026-01-01T12:00:00.000Z",
    "eventName": "string",
    "seatInfo": {
      "seat": "string",
      "section": "string",
      "row": "string",
      "gate": "string"
    },
    "recipientTitle": "string",
    "voided": true,
    "voidedAt": "2026-01-01T12:00:00.000Z",
    "isNonMemberTicket": true,
    "currentStamps": 1,
    "lifetimeStampsEarned": 1,
    "lastStampUpdate": "2026-01-01T12:00:00.000Z",
    "createdAt": "2026-01-01T12:00:00.000Z",
    "updatedAt": "2026-01-01T12:00:00.000Z",
    "membershipManaged": true,
    "memberMembershipId": "string"
  }
}

Response Fields

Field	Type	Description	Attributes
success	boolean
message	string
data	object		Show child attributes _id: string serialNumber: string status: active, inactive, expired, void member: string or object Show child attributes _id: string title: Mr, Ms, Mrs, Miss, Sir, Madam, Dr, Rev — Optional member title or honorific. name: string — Member full name. firstName: string — Member first name. lastName: string — Member last name. email: string (email) — Member email address. Used for pass delivery emails when a pass is issued. address: object Show child attributes addressLine1: string addressLine2: string city: string region: string — State, county, province, or region. postalCode: string country: string — Country name or ISO country code. contactPreferences: object — Optional marketing communication preferences. Essential service communications are unaffected. Show child attributes email: boolean post: boolean phone: boolean memberId: string — External or organisation-defined member identifier. memberSince: string (date-time) — Date the member joined. Defaults to the creation date when omitted. type: Member, Visitor — Member category. Defaults to Member when omitted. status: active, inactive — Member account status. Defaults to active when omitted. location: string — Member location or branch. phone: string — Member phone number. dateOfBirth: string (date-time) — Member date of birth. gender: male, female, other, prefer_not_to_say — Member gender. notes: string — Internal member notes. flagged: boolean — Whether the member is flagged for staff attention. flagNote: string — Optional note shown when the member is flagged. customFields: object — Organisation-defined custom field values keyed by custom field key. Use customFields only for fields configured by the organisation; use first-party fields such as phone, dateOfBirth, gender, and notes at the top level. passes: array of object — Pass wrappers included by member list and lookup endpoints Show child attributes passInstance: object issuedAt: string (date-time) issuedBy: string or object status: active, inactive, expired, void expiryDate: string (date-time) createdAt: string (date-time) updatedAt: string (date-time) walletSummary: object — Included on member list responses Show child attributes total: integer added: integer status: no_pass, added, not_added photo: string — Stored member photo URL linkedMemberGroupId: string pass: string or object Show child attributes _id: string name: string description: string type: generic, eventTicket, loyalty approved: boolean design: object — Visual design settings used when rendering Apple Wallet and Google Wallet passes. Show child attributes backgroundColor: string — Primary pass background color. foregroundColor: string — Primary text color. labelColor: string — Label text color. voidedBackgroundColor: string — Background color shown for voided passes. logoText: string — Text displayed alongside or instead of a logo where supported. icon: string (uri) — Icon image URL used by wallet platforms. appleLogo: string (uri) — Apple Wallet logo image URL. googleLogo: string (uri) — Google Wallet logo image URL. googleWideLogo: string (uri) — Google Wallet wide logo image URL, commonly used for loyalty passes. heroImage: string (uri) — Google Wallet hero image URL. stripImage: string (uri) — Apple Wallet strip image URL, commonly used for event tickets. colorVariants: array of object — Optional conditional color variants matched against member, pass, or custom field values. loyalty: object — Loyalty pass configuration. Present for loyalty pass templates. Show child attributes initialStamps: integer — Number of stamps a loyalty pass starts with. maxStamps: integer — Number of stamps required to complete the loyalty card. emptyStampIconBgColor: string — Background color for empty stamp slots. filledStampIcon: string (uri) — Filled stamp icon image URL. filledStampIconBgColor: string — Background color for filled stamp slots. rewardIcon: string (uri) — Reward icon image URL. stripBackgroundColor: string — Background color for the loyalty stamp strip. stripBackgroundImage: string (uri) — Optional custom strip background image URL. stampShape: circle, rounded, square — Shape used for stamp slots. issueRewards: boolean — Whether rewards are issued automatically when the card reaches maxStamps. deactivateOnMaxStamps: boolean — Whether the loyalty pass is set inactive after reaching maxStamps. rewardTitle: string — Title used for generated rewards. rewardDescription: string — Description used for generated rewards. stampSingular: string — Singular label for a stamp. stampPlural: string — Plural label for stamps. recipientName: string recipientEmail: string (email) expiryDate: string (date-time) issuedAt: string (date-time) walletUrls: object Show child attributes apple: string (uri) google: string (uri) maxUses: integer — Maximum number of successful scans allowed for an event ticket. Defaults to 1 for tickets issued before multi-use support or when omitted. usesRemaining: integer — Remaining successful scans available on an event ticket. redeemedCount: integer — Number of successful event ticket redemptions. lastRedeemedAt: string (date-time) — Timestamp of the latest successful event ticket redemption. passType: generic, eventTicket, loyalty customFields: object eventTime: string (date-time) eventName: string seatInfo: object Show child attributes seat: string section: string row: string gate: string — Optional event ticket gate recipientTitle: string voided: boolean voidedAt: string (date-time) isNonMemberTicket: boolean currentStamps: number lifetimeStampsEarned: number lastStampUpdate: string (date-time) createdAt: string (date-time) updatedAt: string (date-time) membershipManaged: boolean — Included within member lookup pass wrappers memberMembershipId: string — Managing membership _id, when included in a member lookup pass wrapper