List Transaction Batches

GET {{baseUrl}}/directories/:directoryId/transactionbatches?pageSize=100&skipToken=<string>

Page through all the transaction batches in the specified directory <!--From Readme-->

Transaction Definition

A transaction means any customer interaction that we want to associate with a contact. It can then be used as selection criteria for survey distribution.

These are different than, but similar to, transactions embedded into a contact's record. That is on the contact record. Transactions here are individual transactions appended to the user record, like this example below, which shows a sales transaction. But it could be any kind of customer interaction, like a comment from Saleforce or a ticket resolution from Zendesk.

{
  "result": {
    "contactId": "CID_6FDjfOLAQtB7T9z",
    "mailingListId": "CG_bmciqpffjUw2Pjf",
    "transactionDate": "2017-12-11 00:00:00",
    "data": {
      "amount": "546",
      "currency": "USD",
      "productNumber": "Home equity",
      "type": "open account"
    },
    "transactionId": "CTR_3xePNXNaHMC3EJn"
  },
  "meta": {
    "httpStatus": "200 - OK",
    "requestId": "ac514ae6-6765-4b3a-b3bd-0255d5ebb7f3"
  }
}

Request Params

KeyDatatypeRequiredDescription
pageSizenumberThe maximum number of items to return per request
skipTokenstringThe start position for pagination

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;result&quot;:{&quot;elements&quot;:[{&quot;batchId&quot;:&quot;\u003cstring\u003e&quot;,&quot;creationDate&quot;:&quot;\u003cdateTime\u003e&quot;},{&quot;batchId&quot;:&quot;\u003cstring\u003e&quot;,&quot;creationDate&quot;:&quot;\u003cdateTime\u003e&quot;}],&quot;nextPage&quot;:&quot;\u003cstring\u003e&quot;},&quot;meta&quot;:{&quot;httpStatus&quot;:&quot;\u003cstring\u003e&quot;,&quot;requestId&quot;:&quot;\u003cstring\u003e&quot;,&quot;notice&quot;:&quot;\u003cstring\u003e&quot;}}