TAtalon
Customer data

List customer profiles matching the given attributes

[!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.

Get a list of the customer profiles matching the provided criteria.

The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request.

post/v1/customer_search/no_total

Request

Query parameters

pageSizeinteger

The number of items in the response.

skipinteger

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

sandboxboolean

Indicates whether you are pointing to a sandbox or live customer.

Request body

attributesobject

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

integrationIDsstring[]
profileIDsinteger[]

Response

OK

hasMoreboolean
totalResultSizeinteger

Example response

{
  "data": [
    {
      "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.