Skip to main content

List members

GET /members

Requires the members:read permission.

Authorization

X-API-Key required

Parameters

NameLocationTypeRequiredDefaultLimits
limitqueryintegerNo10min 1, max 100
pagequeryintegerNo1min 1
searchquerystringNo
statusqueryactive, inactiveNo

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 "Authorization: Bearer YOUR_API_KEY"

Responses

StatusDescription
200Members retrieved.
400Bad request or validation error.
401Missing or invalid API key.
403The caller is not allowed to access this resource.
500Server error.

200 Response Example

{
"success": true,
"message": "string",
"data": [
{
"_id": "507f1f77bcf86cd799439011",
"title": "Mr",
"name": "John Doe",
"email": "john@example.com",
"memberId": "MEM001",
"type": "Member",
"status": "active",
"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

FieldTypeAttributes
successboolean
messagestring
dataarray of object
Show child attributes
  • _id: string
  • title: Mr, Ms, Mrs, Miss, Sir, Madam, Dr, Rev
  • name: string
  • email: string (email)
  • memberId: string
  • type: Member, Visitor
  • status: active, inactive
  • customFields: object
  • passes: integer
  • createdAt: string (date-time)
  • updatedAt: string (date-time)
paginationobject
Show child attributes
  • currentPage: integer
  • totalPages: integer
  • totalItems: integer
  • itemsPerPage: integer
  • hasNextPage: boolean
  • hasPrevPage: boolean