Skip to main content

Get a member

GET /members/{id}

Requires the members:read permission.

Authorization

X-API-Key required

Parameters

NameLocationTypeRequired
idpathstringYes

Request Examples

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

Use Case Examples

Get member by ID

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

Responses

StatusDescription
200Member retrieved.
400Bad request. The top-level message explains what is invalid and, where applicable, the errors array contains structured field details.
401Missing or invalid API key.
403The caller is not allowed to access this resource.
404Resource not found.
500Server 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"
}
}

Response Fields

FieldTypeAttributes
successboolean
messagestring
dataobject
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)