{"_id":"5846646bd143060f0054baf8","__v":4,"category":{"_id":"55d3c6a4fe37111900e536f9","__v":0,"version":"558444ceafccfd0d00fcb2bb","pages":[],"project":"55843604fd8d910d007b9502","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-18T23:58:28.218Z","from_sync":false,"order":23,"slug":"directory","title":"Target Audience"},"version":{"_id":"558444ceafccfd0d00fcb2bb","forked_from":"55843604fd8d910d007b9505","project":"55843604fd8d910d007b9502","__v":46,"createdAt":"2015-06-19T16:35:26.435Z","releaseDate":"2015-06-19T16:35:26.435Z","categories":["558444cfafccfd0d00fcb2bc","558444cfafccfd0d00fcb2bd","55ad4ce733616a0d00599d2e","55ad4cef6aadf20d0015b764","55ad4cf36aadf20d0015b765","55ad4cfb24cf160d0013584f","55ad4d0024cf160d00135850","55ad4d0a24cf160d00135851","55ad4d0d24cf160d00135852","55ad4d126aadf20d0015b766","55ad4d1624cf160d00135853","55ad4d1933616a0d00599d2f","55ad4d2233616a0d00599d30","55ad4d2e24cf160d00135854","55d35b6bf77e6d0d00b1b092","55d3649a0168850d0073f14a","55d366d40168850d0073f15a","55d37fcff77e6d0d00b1b13f","55d383e50168850d0073f1e1","55d3ac26c336ec0d007c2251","55d3c51cb2330119009c31db","55d3c59bfe37111900e536f3","55d3c5a7fe37111900e536f4","55d3c5b4fe37111900e536f5","55d3c5d4fe37111900e536f6","55d3c5d6b2330119009c31df","55d3c5d71f478b170077c164","55d3c687b2330119009c31e4","55d3c6a4fe37111900e536f9","55d3c6befe37111900e536fa","55d3c6e8d2c66f0d00497f93","55d49dcfd7c16b2d007de905","55d4ca8f5082980d0009c79b","55d4cab9c95a3d2f0069ad3d","55d4d279c95a3d2f0069ad60","55d4d9355082980d0009c7e1","55d4f6b5988e130d000b3eb1","55d64dc8e60a2f0d00b88ecb","5627ca43fcbbc621004ec07d","56c64a0d8f98b50d0012c37c","56f1b8b13eb62a34003ea041","56f1b9df4476fb2200795e8c","57f6907dca5e5d1700039ae9","591dd06ca266c423002ec4ca","59234825e465c11900922518","5936f82eaa591e0027638d57","59972f54fd7078001992c136"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"project":"55843604fd8d910d007b9502","parentDoc":null,"user":"57ab6eabb5e8742000e17e7d","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-12-06T07:10:35.360Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"curl 'https://yourdatacenterid.qualtrics.com/API/v3/directories/POOL_012345678901234/contacts/CID_012345678901234/transactions?withData=true&pageSize=2' \\\n-X GET \\\n-H 'X-API-TOKEN: yourtokenhere'"}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"result\": {\n    \"elements\": [\n      {\n        \"transactionId\": \"CTR_eyQvFrZ11n54Uuh\",\n        \"contactId\": \"CID_012345678901234\",\n        \"mailingListId\": \"CG_e888sCAXgOh194x\",\n        \"transactionDate\": \"2016-11-30 13:15:02\",\n        \"data\": {\n          \"field1\": \"fieldValue1\"\n        }\n      },\n      {\n        \"transactionId\": \"CTR_3DzxXfwKBBkAbLT\",\n        \"contactId\": \"CID_012345678901234\",\n        \"mailingListId\": \"CG_0CgJ5dzzztIvxIN\",\n        \"transactionDate\": \"2016-10-12 09:56:25\",\n        \"data\": {\n          \"field2\": \"fieldValue2\"\n        }\n      }\n    ],\n    \"nextPage\": \"https://yourdatacenterid.qualtrics.com/API/v3/directories/POOL_012345678901234/contacts/CID_012345678901234/transactions?withData=true&pageSize=2&skipToken=CTR_012345678901234\"\n  },\n  \"meta\": {\n    \"httpStatus\": \"200 - OK\",\n    \"requestId\": \"623c59ba-6df1-4949-8d91-1ba43c53c445\"\n  }  \n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"584626a4cdb4f10f001415f6","ref":"","in":"path","required":true,"desc":"The directory ID, also known as a pool ID","default":"","type":"string","name":"directoryId"},{"_id":"58464af5b17e5e19005874b0","ref":"","in":"path","required":true,"desc":"The ID of the contact for which transactions will be retrieved","default":"","type":"string","name":"contactId"},{"_id":"58466513f7ecc10f00c8f28c","ref":"","in":"query","required":false,"desc":"Specifies if the **data** object is returned for each transaction","default":"false","type":"boolean","name":"withData"},{"_id":"584665854469290f007f74d8","ref":"","in":"query","required":false,"desc":"Specifies how many transactions to list per page; the minimum is **1**, the maximum is **200**","default":"200","type":"int","name":"pageSize"},{"_id":"5846688e8909160f00e71443","ref":"","in":"query","required":false,"desc":"A value that determines the starting point for the next page of transactions","default":"","type":"string","name":"skipToken"}],"url":"/v:version/directories/:directoryId/contacts/:contactId/transactions"},"isReference":false,"order":6,"body":"","excerpt":"Page through all the transactions for the specified contact","slug":"get-contact-transactions","type":"endpoint","title":"Get Contact Transactions"}

getGet Contact Transactions

Page through all the transactions for the specified contact

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

directoryId:
required
string
The directory ID, also known as a pool ID
contactId:
required
string
The ID of the contact for which transactions will be retrieved

Query Params

withData:
booleanfalse
Specifies if the **data** object is returned for each transaction
pageSize:
integer200
Specifies how many transactions to list per page; the minimum is **1**, the maximum is **200**
skipToken:
string
A value that determines the starting point for the next page of transactions

Examples


Result Format


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}