{"_id":"57028efe12b0f11900f9d602","parentDoc":null,"__v":2,"editedParams":true,"project":"55843604fd8d910d007b9502","user":"558435c2fb52ee0d0015d190","version":{"_id":"558444ceafccfd0d00fcb2bb","forked_from":"55843604fd8d910d007b9505","project":"55843604fd8d910d007b9502","__v":60,"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","599c6da8f180820025f14909","59b054613c3e1b0019cf27d9","59b1ceca2d6231003ad73e5f","59b1cf1857911600382e0dc4","59b1cf2730f3d60010c30ef7","59b1cf385d4b89003035441a","59b1cf5857911600382e0dc6","59bc2c4e26ac9b0010a8b753","59bc2ce20b3eb30010657b70","59f0c793ba3bc90030f413ab","59f0cd62f5ecda00325294b9","59fb55a8e8d0f600101aedc3","59fcb05c067f8d0028613f86","5a2af4a1bc5fba00283909c1"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"category":{"_id":"55d3c5a7fe37111900e536f4","version":"558444ceafccfd0d00fcb2bb","pages":["56ce2c26388ec62500cfc04c"],"project":"55843604fd8d910d007b9502","__v":1,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-18T23:54:15.731Z","from_sync":false,"order":16,"slug":"message-library","title":"Message Library"},"editedParams2":true,"updates":["58e67a353a538c0f00a07999"],"next":{"pages":[],"description":""},"createdAt":"2016-04-04T15:57:50.275Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[{"code":"curl -H 'X-API-TOKEN: yourapitokenhere' 'https://yourdatacenterid.qualtrics.com/API/v3/libraries/GR_6xMwYO5zW4FklUh/messages/'","language":"curl"}]},"method":"get","results":{"codes":[{"name":"","code":"{\n  \"result\": {\n    \"elements\": [\n      {\n        \"id\": \"MS_bOuaBBytjILFzuJ\",\n        \"description\": \"Api Email Subject Test\",\n        \"category\": \"emailSubject\"\n      },\n      {\n        \"id\": \"MS_5o5E28wJn7rDhSR\",\n        \"description\": \"My SMS Invite Message\",\n        \"category\": \"smsInvite\"\n      },\n      {\n        \"id\": \"MS_b3KPWsq6PpAnk33\",\n        \"description\": \"Validation Message 1\",\n        \"category\": \"validation\"\n      },\n      {\n        \"id\": \"MS_5nGuAmq0mr5oXYh\",\n        \"description\": \"Validation Message 2\",\n        \"category\": \"validation\"\n      },\n      {\n        \"id\": \"MS_7TH9n0ktV2A8OgZ\",\n        \"description\": \"Urgent Invite 1\",\n        \"category\": \"invite\"\n      },\n      {\n        \"id\": \"MS_2t2hbTmXIEmVh7D\",\n        \"description\": \"Urgent Invite 2\",\n        \"category\": \"invite\"\n      },\n      {\n        \"id\": \"MS_0omZ2GdHvtBiFSt\",\n        \"description\": \"General Invite\",\n        \"category\": \"invite\"\n      },\n      {\n        \"id\": \"MS_3KLeYqzTMSHkSY5\",\n        \"description\": \"Long Time Customer Invite\",\n        \"category\": \"invite\"\n      },\n    ],\n    \"nextPage\": \"https://localhost:9000/API/v3/messages/?pageOffset=10\"\n  },\n  \"meta\": {\n    \"httpStatus\": \"200 - OK\"\n  }\n}","language":"json","status":200}]},"auth":"required","params":[{"_id":"55d36ef8f77e6d0d00b1b0f9","ref":"","in":"path","required":true,"desc":"The Library ID can be one of the following IDs: User ID, Group ID","default":"","type":"string","name":"libraryId"},{"_id":"56cdefcd49abf10b0036a345","ref":"","in":"query","required":false,"desc":"Category filter. Valid categories include: invite, inactiveSurvey, reminder, thankYou, endOfSurvey, general, lookAndFeel, emailSubject, smsInvite","default":"","type":"string","name":"category"},{"_id":"595fb4a05c5582001bb74f58","ref":"","in":"query","required":false,"desc":"The starting offset for the pagination. The default offset is 0. If there are additional pages, the offset value for the next page will be appended to the value of the nextPage parameter in the response.","default":"","type":"int","name":"pageOffset"}],"url":"/v:version/libraries/:libraryId/messages"},"isReference":false,"order":1,"body":"","excerpt":"Get information on all messages in a library","slug":"get-library-messages","type":"endpoint","title":"Get Library Messages"}

getGet Library Messages

Get information on all messages in a library

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

libraryId:
required
string
The Library ID can be one of the following IDs: User ID, Group ID

Query Params

category:
string
Category filter. Valid categories include: invite, inactiveSurvey, reminder, thankYou, endOfSurvey, general, lookAndFeel, emailSubject, smsInvite
pageOffset:
integer
The starting offset for the pagination. The default offset is 0. If there are additional pages, the offset value for the next page will be appended to the value of the nextPage parameter in the response.

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 }}