v1

latestOpenAPI 3.0.12026-08-06135498863.0 KB

Members

Gets the details of the currently authenticated member

The member is always reloaded directly from Loyalty with no caching.

Licenses Required

Vista.Ocapi

get/ocapi/v1/members/current

Headers

loyaltySessionTokenstring

Current Loyalty session token, represents a 'signed-in' member

Connect-Region-Codestring

Region Code

Response

Success

Example response

{
  "member": {
    "personalDetails": {
      "contactDetails": {
        "address": {
          "line1": "60 Khyber Pass Road",
          "suburb": "Grafton",
          "city": "Auckland",
          "postCode": "1023",
          "country": "New Zealand"
        }
      },
      "preferences": {
        "languageTag": "en-US"
      }
    }
  },
  "relatedData": {
    "balanceTypes": [
      {
        "name": {
          "translations": [
            {
              "languageTag": "en-US"
            }
          ]
        },
        "unitName": "Points"
      }
    ],
    "club": {
      "name": {
        "translations": [
          {
            "languageTag": "en-US"
          }
        ]
      }
    },
    "clubLevel": {
      "name": {
        "translations": [
          {
            "languageTag": "en-US"
          }
        ]
      }
    },
    "customPreferences": [
      {
        "name": {
          "translations": [
            {
              "languageTag": "en-US"
            }
          ]
        },
        "options": [
          {
            "name": {
              "translations": [
                {
                  "languageTag": "en-US"
                }
              ]
            }
          }
        ]
      }
    ],
    "educationLevel": {
      "name": {
        "translations": [
          {
            "languageTag": "en-US"
          }
        ]
      }
    },
    "genres": [
      {
        "name": {
          "translations": [
            {
              "languageTag": "en-US"
            }
          ]
        }
      }
    ],
    "interests": [
      {
        "name": {
          "translations": [
            {
              "languageTag": "en-US"
            }
          ]
        }
      }
    ],
    "interestContactMethods": [
      {
        "name": {
          "translations": [
            {
              "languageTag": "en-US"
            }
          ]
        }
      }
    ],
    "occupation": {
      "name": {
        "translations": [
          {
            "languageTag": "en-US"
          }
        ]
      }
    },
    "sites": [
      {
        "contactDetails": {
          "address": {
            "line1": "60 Khyber Pass Road",
            "line2": "Grafton",
            "city": "Auckland 1023"
          }
        },
        "ianaTimeZoneName": "America/New_York",
        "name": {
          "translations": [
            {
              "languageTag": "en-US"
            }
          ]
        }
      }
    ],
    "subscriptions": [
      {
        "name": {
          "translations": [
            {
              "languageTag": "en-US"
            }
          ]
        }
      }
    ]
  }
}