Get Members | NaviPartner | NP Retail API Documentation

curl https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./membership/cdef7890-abcd-0123-1234-567890abcdef/members \
     -H "x-np-api-key: <NaviPartner API Key>"

{
  "membership": {
    "autoRenewalActivated": false,
    "blocked": false,
    "communityCode": "RIVERLAND",
    "issueDate": "2024-09-17",
    "membershipCode": "GOLD",
    "membershipId": "cdef7890-abcd-0123-1234-567890abcdef",
    "membershipNumber": "MS-DEMO-00152",
    "attributes": [],
    "customerNumber": "D000188",
    "members": [
      {
        "role": "membershipAdmin",
        "contactNumber": "C1234567890",
        "member": {
          "blocked": false,
          "cards": [
            {
              "cardNumber": "MC1234567890",
              "expiryDate": "2029-09-17",
              "temporary": false,
              "createdAt": "2024-09-17T00:00:00",
              "modifiedAt": "2024-09-18T00:00:00",
              "cardId": "12345678-abcd-1234-5678-1234567890ab",
              "blocked": false,
              "pinCode": "1234"
            }
          ],
          "memberId": "12345678-abcd-1234-5678-1234567890ab",
          "memberNumber": "M123456789",
          "address": "123 Main Street",
          "attributes": [],
          "birthday": "1980-01-01",
          "city": "New York",
          "country": "USA",
          "email": "john.doe@acme.com",
          "firstName": "John",
          "gender": "male",
          "lastName": "Doe",
          "middleName": "A.",
          "newsletter": "yes",
          "phoneNo": "+1234567890",
          "postCode": "12345"
        },
        "gdprConsent": "pending"
      }
    ],
    "validFromDate": "2024-09-17",
    "validUntilDate": "2025-09-16"
  }
}

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.

Authentication

x-np-api-keystring

API Key authentication via header

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.

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.

Authentication

Path parameters

Headers

Response