List Members
Search and list members scoped to your organization
/partner/membersOverview
Search and list members associated with your organization. Results are automatically scoped to the calling key's organization — guests who have stayed at your properties or been linked to your org.
Authentication
Requires a partner API key with the partner:guests:read scope, sent as X-API-Key.
Query Parameters
qquerystringSearch query across member name, email, and member code. Minimum 2 characters.
organizationIdquerystringExternal org ID (HXP UUID or WorkOS org ID). For superadmin keys only — org-scoped keys ignore this.
offsetquerynumberdefault: 0Pagination offset
limitquerynumberdefault: 20Results per page (max 100)
Response
itemsarrayrequiredMember records
member object
memberobject{ externalId, memberCode, displayName, firstName, lastName, avatarUrl, status, memberSince }
profileobject | null{ dateOfBirth, gender, nationality, timezone, language }
contactsarray[{ contactType, contactValue, isPrimary }]
walletobject | null{ walletId, spendablePoints, validBalance, creditBalance }
loyaltyobject{ tierLevel, tierName, lifetimePoints, currentYearPoints, pointsToNextTier, nextTierName }
addressobject | null{ street, city, state, postalCode, country }
totalnumberrequiredoffsetnumberrequiredlimitnumberrequiredRequest
curl "https://api-prd.cf.journey.com/v1/partner/members?q=smith&limit=20" \
-H "X-API-Key: jny_xxxx"Response
{
"items": [
{
"member": {
"externalId": "01J5XYZ",
"memberCode": "ABC123",
"displayName": "John Smith",
"firstName": "John",
"lastName": "Smith",
"avatarUrl": null,
"status": "active",
"memberSince": "2024-01-15T00:00:00Z"
},
"profile": {
"dateOfBirth": null,
"gender": null,
"nationality": "US",
"timezone": "America/New_York",
"language": "en"
},
"contacts": [
{ "contactType": "email", "contactValue": "j***@example.com", "isPrimary": true }
],
"wallet": {
"walletId": "wal_01J5XYZ",
"spendablePoints": 12500,
"validBalance": 12500,
"creditBalance": 0
},
"loyalty": {
"tierLevel": 2,
"tierName": "Silver",
"lifetimePoints": 48000,
"currentYearPoints": 12500,
"pointsToNextTier": 12500,
"nextTierName": "Gold"
},
"address": null
}
],
"total": 1,
"offset": 0,
"limit": 20
}