TAtalon
Customer data

List application's customers

Changed on

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

List all the customers of the specified application.

get/v1/applications/{applicationId}/customers

Request

Path parameters

applicationIdinteger required

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

Query parameters

integrationIdstring

Filter results performing an exact matching against the profile integration identifier.

pageSizeinteger

The number of items in the response.

skipinteger

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

When set to true, the loyaltyProgramJoinDates property returns the dates on which each customer joined the profile-based loyalty programs they are part of. This might decrease performance on large data sets.

Response

OK

totalResultSizeinteger
hasMoreboolean

Example response

{
  "totalResultSize": 1,
  "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",
      "loyaltyProgramJoinDates": [
        {
          "joined": "2012-03-20T14:15:22Z",
          "loyaltyProgramId": 323414846
        }
      ]
    }
  ]
}

Changes

  • 7ef1b9504c3aRevision changes
    • info

      added the new optional query request parameter withLoyaltyMemberships

    • info

      added the optional property /// to the response with the status