Customer data

List Application sessions

[!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 sessions of the specified Application.

get/v1/applications/{applicationId}/sessions

Request

Path parameters

applicationIdinteger required

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

Query parameters

pageSizeinteger

The number of items in the response.

skipinteger

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

sortstring

The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with -.

Note: You may not be able to use all fields for sorting. This is due to performance limitations.

partialMatchboolean

Enables partial matching for a single text search field. When enabled, the search term matches anywhere within the field value (case-insensitive). Minimum 3 characters required for partial matches; shorter inputs automatically fall back to exact match.

Note: Use with one of: integrationId, profile, coupon, referral, or storeIntegrationId.

profilestring

Filter by sessions with this profile integration ID. By default, requires exact match. Use partialMatch=true to search for partial matches (minimum 3 characters).

state'open' | 'closed' | 'partially_returned' | 'cancelled'

Filter by sessions with this state. Must be exact match.

createdBeforestring date-time

Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.

createdAfterstring date-time

Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.

couponstring

Filter by sessions with this coupon. By default, requires exact match. Use partialMatch=true to search for partial matches (minimum 3 characters).

referralstring

Filter by sessions with this referral. By default, requires exact match. Use partialMatch=true to search for partial matches (minimum 3 characters).

integrationIdstring

Filter by sessions with this integration ID. By default, requires exact match. Use partialMatch=true to search for partial matches (minimum 3 characters).

storeIntegrationIdstring

The integration ID of the store. You choose this ID when you create a store. By default, requires exact match. Use partialMatch=true to search for partial matches (minimum 3 characters).

Response

OK

hasMoreboolean

Example response

{
  "data": [
    {
      "id": 6,
      "created": "2020-02-07T08:15:22Z",
      "integrationId": "URNGV8294NV",
      "storeIntegrationId": "STORE-001",
      "applicationId": 322,
      "profileId": 138,
      "profileintegrationid": "382370BKDB946",
      "coupon": "BKDB946",
      "referral": "BKDB946",
      "state": "closed",
      "cartItems": [
        {
          "name": "Air Glide",
          "sku": "SKU1241028",
          "quantity": 1,
          "returnedQuantity": 1,
          "remainingQuantity": 1,
          "price": 99.99,
          "category": "shoes",
          "product": {
            "name": "sample_product"
          },
          "weight": 1130,
          "attributes": {
            "image": "11.jpeg",
            "material": "leather"
          },
          "additionalCosts": {
            "shipping": {
              "price": 9
            }
          },
          "selectedPriceType": "member",
          "adjustmentReferenceId": "68851723-e6fa-488f-ace9-112581e6c19b",
          "adjustmentEffectiveFrom": "2021-09-12T10:12:42Z",
          "adjustmentEffectiveUntil": "2021-09-12T10:12:42Z",
          "prices": {
            "member": {
              "price": 90,
              "adjustmentReferenceId": "68851723-e6fa-488f-ace9-112581e6c19b",
              "effectiveFrom": "2025-05-25T00:00:00Z",
              "effectiveUntil": "2025-05-30T00:00:00Z"
            },
            "base": {
              "price": 100
            }
          }
        }
      ],
      "totalDiscounts": 100,
      "total": 200
    }
  ]
}

Changes

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