API Documentation

# List Dependents v2.0Beta

The List Dependent endpoint retrieves a list of dependents for a customer profile. The request will return a list of all the dependents.

# Request

GET /v2.0/customers/{profileKey}/dependents

# 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.

# Response

200
OK
Returns an array of Dependent resources wrapped in an ApiListResponse envelope.

# Response Body

The endpoint returns our ApiListResponse envelope. The data property of the response will contain an array of Dependent resources.

# Sample

{
    "message": "The operation succeeded! 2 records returned.",
    "notifications": [],
    "data": [
        {
            "key": "e22afacc-bb1g-4d3d-95c4-f7184afcc355",
            "profileKey": "25b7726e-8416-5b13-a54a-b7fae6518b8g",
            "profileBrandGroupKey": "TEST-SPUR-PROFILE",
            "firstName": "Adam",
            "lastName": "Jones",
            "gender": "Male",
            "birthDate": "2011-06-06T00:00:00",
            "age": 10,
            "nextBirthdayOn": "2022-06-06T00:00:00",
            "daysToNextBirthday": 294,
            "customerRelationship": "Father"
        },
        {
            "key": "e981ceeb-7d94-418a-9dcf-98f85c9fe47f",
            "profileKey": "25b7726e-8416-5b13-a54a-b7fae6518b8g",
            "profileBrandGroupKey": "TEST-SPUR-PROFILE",
            "firstName": "Rachel",
            "lastName": "Jones",
            "gender": "Female",
            "birthDate": "2009-10-29T00:00:00",
            "age": 11,
            "nextBirthdayOn": "2021-10-29T00:00:00",
            "daysToNextBirthday": 71,
            "customerRelationship": null
        }
    ]
}

# Errors

The standard error responses apply.

401
Unauthorized
When authentication fails.
403
Forbidden
When authorisation fails.
404
Not Found
When the customer profile cannot be found.

← Get Dependent →