Customer data

Get customer profile

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

Return the details of the specified customer profile.

[!note] You can retrieve the same information via the Integration API, which can save you extra API requests. Consider these options:

Request the customer profile to be part of the response content using Update Customer Session.

Send an empty update with the Update Customer Profile endpoint with runRuleEngine=false.

get/v1/customers/{customerId}

Request

Base URL
https://yourbaseurl.talon.one
Auth
- API key in header Authorization
- or API key in header Authorization
TypeScript
https://skmtc.dev/talon/apis/management-api/docs/v1/customers/:customerId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

customerIdinteger required

The value of the id property of a customer profile. Get it with the List Application's customers endpoint.

Response

idinteger required

The internal ID of the customer profile.

createdstring date-time required

The time this entity was created.

integrationIdstring string required

The integration ID set by your integration layer.

attributesobject required

Arbitrary properties associated with this item.

accountIdinteger required

The ID of the Talon.One account that owns this profile.

closedSessionsinteger required

The total number of closed sessions. Does not include closed sessions that have been cancelled or reopened. See the docs.

totalSalesnumber required

The total amount of money spent by the customer before discounts are applied.

The total sales amount excludes the following:

Cancelled or reopened sessions.
Returned items.

lastActivitystring date-time required

Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not dry requests.

For example, reserving a coupon for a customer doesn't impact this field.

sandboxboolean

An indicator of whether the customer is part of a sandbox or live Application. See the docs.

Example response

{
  "id": 6,
  "created": "2020-02-07T08:15:22Z",
  "integrationId": "URNGV8294NV",
  "attributes": {
    "Language": "english",
    "ShippingCountry": "DE"
  },
  "accountId": 31,
  "closedSessions": 3,
  "totalSales": 299.99,
  "loyaltyMemberships": [
    {
      "joined": "2012-03-20T14:15:22Z",
      "loyaltyProgramId": 323414846
    }
  ],
  "audienceMemberships": [
    {
      "id": 2,
      "name": "Travel audience"
    }
  ],
  "lastActivity": "2020-02-08T14:15:20Z"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.