# Get Customer v2.0Beta
The Get Customer endpoint retrieves the details for a customer profile. A single customer profile record will be returned. Expands can be used to retrieve a customer profile with related data.
# Request
# Authorization
An OAuth 2.0 Bearer token with the Profile.Read
scope is required. For more information, see Authentication.
# Path Parameters
A list of the supported path parameters is described below.
Name | Required | Type | Description |
---|---|---|---|
profileKey | true | guid | The profile key for the customer. This value can be retrieved from the profileKey claim in the token returned from our SSO solution. |
# Query Parameters
A list of the supported query parameters is described below.
Name | Required | Type | Description |
---|---|---|---|
expand | false | string[] | Provide a list of array properties that should be expanded in the response. See Expands below for more information. |
# Expands
The expand
parameter allows some arrays in the response object to be expanded in the response. We support this to allow you to control the amount of data you will get in the response. Pick only the data you need for the specific scenario and we'll send you less data, faster.
Valid values are: addresses
or dependents
or any combination thereof.
# Response
# Response Body
The endpoint returns our ApiResponse envelope. The data
property of the response will contain a Customer resource.
# Sample
{
"message": "The operation succeeded!",
"notifications": [],
"data": {
"profileKey": "25b7726e-8416-5b13-a54a-b7fae6518b8g",
"profileBrandGroupKey": "TEST-SPUR-PROFILE",
"firstName": "Bridget",
"lastName": "Jones",
"mobilePhone": "+27831554241",
"mobileCountryCode": "ZA",
"mobileVerified": true,
"emailAddress": "bridgetjones@gmail.com",
"emailVerified": false,
"termsAccepted": true,
"termsAcceptedOn": "2021-08-16T11:52:45",
"gender": "Female",
"homeLanguage": "English",
"birthDate": "1978-07-13",
"age": 43,
"nextBirthdayOn": "2022-07-13",
"daysToNextBirthday": 331,
"dependentCount": 3,
"dependentLimitReached": false,
"dependents": [],
"addresses": [],
"createdOn": "2015-10-05T19:22:46",
"modifiedOn": "2021-08-16T11:54:45.39"
}
}
# Errors
The standard error responses apply.