List pass instances

GET /passes

Requires the passes:read permission.

Authorization

X-API-Key required

Parameters

Name	Location	Type	Required	Default	Limits
limit	query	integer	No	10	min 1, max 100
page	query	integer	No	1	min 1
status	query	active, inactive, expired, void	No
memberId	query	string	No
includeVoid	query	boolean	No	false

Request Examples

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

Use Case Examples

List pass instances with filtering

curl -X GET "https://api.remypass.com/api/v1/public/passes?limit=50&page=1&status=active&memberId=507f1f77bcf86cd799439011" \
  -H "X-API-Key: YOUR_API_KEY"

Responses

Status	Description
200	Pass instances 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.
500	Server error.

200 Response Example

{
  "success": true,
  "message": "string",
  "data": [
    {
      "_id": "507f1f77bcf86cd799439013",
      "serialNumber": "string",
      "status": "active",
      "member": {},
      "pass": {},
      "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"
    }
  ],
  "pagination": {
    "currentPage": 1,
    "totalPages": 5,
    "totalItems": 47,
    "itemsPerPage": 10,
    "hasNextPage": true,
    "hasPrevPage": false
  }
}

Response Fields

Field	Type	Attributes
success	boolean
message	string
data	array of 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 name: string firstName: string lastName: string email: string (email) address: object Show child attributes addressLine1: string addressLine2: string city: string region: string postalCode: string country: string contactPreferences: object Show child attributes email: boolean post: boolean phone: boolean memberId: string memberSince: string (date-time) type: Member, Visitor status: active, inactive location: string phone: string dateOfBirth: string (date) gender: male, female, other, prefer_not_to_say notes: string flagged: boolean flagNote: string customFields: object passes: integer createdAt: string (date-time) updatedAt: string (date-time) pass: string or object Show child attributes _id: string name: string description: string type: string approved: boolean design: object Show child attributes backgroundColor: string foregroundColor: string labelColor: string voidedBackgroundColor: string logoText: string icon: string (uri) appleLogo: string (uri) googleLogo: string (uri) googleWideLogo: string (uri) heroImage: string (uri) stripImage: string (uri) colorVariants: array of object loyalty: object Show child attributes initialStamps: integer maxStamps: integer emptyStampIconBgColor: string filledStampIcon: string (uri) filledStampIconBgColor: string rewardIcon: string (uri) stripBackgroundColor: string stripBackgroundImage: string (uri) stampShape: circle, rounded, square issueRewards: boolean deactivateOnMaxStamps: boolean rewardTitle: string rewardDescription: string stampSingular: string stampPlural: string 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 usesRemaining: integer redeemedCount: integer lastRedeemedAt: string (date-time)
pagination	object	Show child attributes currentPage: integer totalPages: integer totalItems: integer itemsPerPage: integer hasNextPage: boolean hasPrevPage: boolean