API Documentation

# Lookup Customer Relationships v2.0Beta

The Lookup Customer Relationships endpoint allows a developer to retrieve valid relationship values that may be used for Add Dependent and Update Dependent requests.

GET /v2.0/lookups/customer/relationships

# Request

The request will get a list of relationships.

# Response

200
OK
Returns a Lookup resource wrapped in an ApiListResponse envelope.

# Response Body

The endpoint returns our ApiListResponse envelope. The data property of the response will contain a Lookup resource.

# Sample

{
    "message": "The operation succeeded!",
    "notifications": [],
    "numberOfRecords": 1,
    "data": [
        {
            "value": "English",
            "sortOrder": 1
        }
    ]
}

# Errors

The standard error responses apply.

401
Unauthorized
When authentication fails.
403
Forbidden
When authorisation fails.

←