List members

GET /members

Requires the members: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
search	query	string	No
status	query	active, inactive	No

Request Examples

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

Use Case Examples

List members with pagination

curl -X GET "https://api.remypass.com/api/v1/public/members?limit=25&page=1&search=john&status=active" \
  -H "X-API-Key: YOUR_API_KEY"

Responses

Status	Description
200	Members 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": "507f1f77bcf86cd799439011",
      "title": "Mr",
      "name": "John Doe",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john@example.com",
      "address": {
        "addressLine1": "23 Gastons Road",
        "addressLine2": "",
        "city": "London",
        "region": "Greater London",
        "postalCode": "SW1A 1AA",
        "country": "United Kingdom"
      },
      "contactPreferences": {
        "email": true,
        "post": true,
        "phone": true
      },
      "memberId": "MEM001",
      "memberSince": "2024-01-15T00:00:00.000Z",
      "type": "Member",
      "status": "active",
      "location": "Main Street",
      "phone": "+447700900123",
      "dateOfBirth": "1990-04-20",
      "gender": "male",
      "notes": "Prefers email contact",
      "flagged": true,
      "flagNote": "Check eligibility before issuing renewal",
      "customFields": {
        "membershipLevel": "Gold",
        "favoriteLocation": "Main Street",
        "newsletterOptIn": true
      },
      "passes": 1,
      "createdAt": "2026-01-01T12:00:00.000Z",
      "updatedAt": "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 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)
pagination	object	Show child attributes currentPage: integer totalPages: integer totalItems: integer itemsPerPage: integer hasNextPage: boolean hasPrevPage: boolean