Get Customer Profile

Get customer profile

GET/v1/customers/{customerId}

Use it in a workflow

Add a step and choose the Talon.One connector.
Pick the Get Customer Profile action (under management).
Fill in the fields below, then reference the result from later steps as {{getCustomerProfile.response.data}}.

Request

Path parameters

customerIdinteger (int64)required

The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationCustomers) endpoint.

Response

Returns 200 with an object. Read it in later steps with {{getCustomerProfile.response.data.<field>}}.

idinteger (int64)

The internal ID of the customer profile.

createdstring (date-time)

The time this entity was created.

integrationIdstring (string)

The integration ID set by your integration layer.

attributesobject

Arbitrary properties associated with this item.

accountIdinteger (int64)

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

closedSessionsinteger (int64)

The total number of closed sessions. Does not include closed sessions that have been cancelled or reopened. See the [docs](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states).

totalSalesnumber

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.

loyaltyMembershipsarray<object>

**DEPRECATED. Always returns `null`.** A list of loyalty programs joined by the customer.

joinedstring (date-time)

The moment in which the loyalty program was joined.

loyaltyProgramIdinteger (int64)required

The ID of the loyalty program belonging to this entity.

audienceMembershipsarray<object>

The audiences the customer belongs to.

idinteger (int64)required

The ID of the audience belonging to this entity.

namestringrequired

The Name of the audience belonging to this entity.

lastActivitystring (date-time)

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](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#tag/Coupons/operation/createCouponReservation) 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](https://docs.talon.one/docs/product/applications/overview#application-environments).

json

{
  "id": 6,
  "created": {},
  "integrationId": "URNGV8294NV",
  "attributes": {
    "Language": "english",
    "ShippingCountry": "DE"
  },
  "accountId": 31,
  "closedSessions": 3,
  "totalSales": 299.99,
  "lastActivity": {},
  "loyaltyMemberships": [
    {
      "joined": {},
      "loyaltyProgramId": 323414846
    }
  ],
  "audienceMemberships": [
    {
      "name": "Travel audience",
      "id": 2
    }
  ],
  "sandbox": false
}

Need more? See the Talon.One guide for connection setup and behaviour shared by every action.

Was this page helpful?