Get Members — NaviPartner | NP Retail API Documentation

This endpoint retrieves all members associated with a specific membership. It is useful you need to see a list of all participants or account holders under a single membership.

Path parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

membershipIdUUIDRequired

Unique identifier for a membership.

Headers

x-api-versiondateOptional

Used for API versioning. More details.

Response

This endpoint returns an object.

membershipobject

This is a composite type representing a Membership and its associated Members. It extends the MembershipEntity and includes a list of members linked to the membership.

cacheInstanceIdstringOptional

Identifier for the NST instance. Providing this value will increase the performance of the API when the NST is load-balanced.

1 curl https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%20International%20Ltd./membership/cdef7890-abcd-0123-1234-567890abcdef/members

1 { 2 "membership": { 3 "blocked": false, 4 "communityCode": "RIVERLAND", 5 "issueDate": "2024-09-17", 6 "membershipCode": "GOLD", 7 "membershipId": "cdef7890-abcd-0123-1234-567890abcdef", 8 "membershipNumber": "MS-DEMO-00152", 9 "customerNumber": "D000188", 10 "members": [ 11 { 12 "role": "membership_admin", 13 "contactNumber": "C1234567890", 14 "member": { 15 "blocked": false, 16 "cards": [ 17 { 18 "cardNumber": "MC1234567890", 19 "expiryDate": "2029-09-17", 20 "temporary": false, 21 "cardId": 123434 22 } 23 ], 24 "memberId": 4331, 25 "memberNumber": "M123456789", 26 "address": "123 Main Street", 27 "birthday": "1980-01-01", 28 "city": "New York", 29 "country": "USA", 30 "email": "john.doe@acme.com", 31 "firstName": "John", 32 "gender": "male", 33 "lastName": "Doe", 34 "middleName": "A.", 35 "newsletter": true, 36 "phoneNo": "+1234567890", 37 "postCode": "12345" 38 } 39 } 40 ], 41 "validFromDate": "2024-09-17", 42 "validUntilDate": "2025-09-16" 43 } 44 }

1	{
2	"membership": {
3	"blocked": false,
4	"communityCode": "RIVERLAND",
5	"issueDate": "2024-09-17",
6	"membershipCode": "GOLD",
7	"membershipId": "cdef7890-abcd-0123-1234-567890abcdef",
8	"membershipNumber": "MS-DEMO-00152",
9	"customerNumber": "D000188",
10	"members": [
11	{
12	"role": "membership_admin",
13	"contactNumber": "C1234567890",
14	"member": {
15	"blocked": false,
16	"cards": [
17	{
18	"cardNumber": "MC1234567890",
19	"expiryDate": "2029-09-17",
20	"temporary": false,
21	"cardId": 123434
22	}
23	],
24	"memberId": 4331,
25	"memberNumber": "M123456789",
26	"address": "123 Main Street",
27	"birthday": "1980-01-01",
28	"city": "New York",
29	"country": "USA",
30	"email": "john.doe@acme.com",
31	"firstName": "John",
32	"gender": "male",
33	"lastName": "Doe",
34	"middleName": "A.",
35	"newsletter": true,
36	"phoneNo": "+1234567890",
37	"postCode": "12345"
38	}
39	}
40	],
41	"validFromDate": "2024-09-17",
42	"validUntilDate": "2025-09-16"
43	}
44	}