younifyd
Menu

Get Application Customers By Attributes

List application customers matching the given attributes

POST/v1/applications/{applicationId}/customer_search

Use it in a workflow

  1. Add a step and choose the Talon.One connector.
  2. Pick the Get Application Customers By Attributes action (under management).
  3. Fill in the fields below, then reference the result from later steps as {{getApplicationCustomersByAttributes.response.data}}.

Request

Path parameters

applicationIdinteger (int64)required

The ID of the Application. It is displayed in your Talon.One deployment URL.

Query parameters

pageSizeinteger (int64)

The number of items in the response.

Default 1000

skipinteger (int64)

The number of items to skip when paging through large result sets.

withTotalResultSizeboolean

When this flag is set, the result includes the total number of results for this query. This might decrease performance on large data sets. - When `true`: `totalResultSize` contains the total number of results for this query. - When `false`: Only `hasMore` is returned, and it is set to `true` when there are more results than shown on the page.

Request body

Enter the body as JSON in the step's Body field.

attributesobject

Properties to match against a customer profile. All provided attributes will be exactly matched against profile attributes.

integrationIDsarray<string>
profileIDsarray<integer (int64)>
json
{
  "attributes": {},
  "integrationIDs": [
    "string"
  ],
  "profileIDs": [
    0
  ]
}

Response

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

hasMoreboolean
totalResultSizeinteger (int64)
dataarray<object>
idinteger (int64)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.

attributesobjectrequired

Arbitrary properties associated with this item.

accountIdinteger (int64)required

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

closedSessionsinteger (int64)required

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

totalSalesnumberrequired

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>2 fields

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

audienceMembershipsarray<object>2 fields

The audiences the customer belongs to.

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](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).

advocateIntegrationIdstring

The Integration ID of the Customer Profile that referred this Customer in the Application.

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

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