GET api/surveys
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Name |
User-readable name of the survey |
string |
None. |
| StoreID |
Store this survey belongs to, 0 or null = all |
integer |
None. |
| ZoneID |
Zone this survey belongs to |
integer |
None. |
| DisplayToWho | SurveyAnswerer |
None. |
|
| DisplayWhen | DisplaySurveyWhen |
None. |
|
| Start | date |
None. |
|
| End | date |
None. |
|
| OrderBy | SurveyOrderBy |
None. |
|
| SortOrder |
Sort Order |
SortOrder |
None. |
| Relations |
true if relational fields should be loaded |
boolean |
None. |
| IncludeDeleted |
tru if surveys that are soft-deleted should be included |
boolean |
None. |
| StoreIDs | Collection of integer |
Relation. This field may not always be loaded or used for updates. |
|
| Skip |
Number of records to skip over |
integer |
None. |
| Take |
Number of records to take |
integer |
None. |
| TotalCount | integer |
Relation. This field may not always be loaded or used for updates. |
Body Parameters
None.
Response Information
Resource Description
PageListOfSurvey| Name | Description | Type | Additional information |
|---|---|---|---|
| Type | string |
None. |
|
| List | Collection of Survey |
None. |
|
| Skip |
Number of records to skip over |
integer |
None. |
| Take |
Number of records to take |
integer |
None. |
| TotalCount | integer |
Relation. This field may not always be loaded or used for updates. |
Response Formats
application/json, text/json
Sample:
{
"type": "Survey",
"list": [
{
"$id": "2",
"g_UID": "JynnzfVx5ECRfhyKimHCDQ==",
"guid": "cde72927-71f5-40e4-917e-1c8a8a61c20d",
"name": "sample string 1",
"storeID": 2,
"zoneID": 1,
"checkoutFormG_UID": "yRGGK+bJRUWJ1hcNq5+r/g==",
"checkoutFormGuid": "2b8611c9-c9e6-4545-89d6-170dab9fabfe",
"displayToWho": 3,
"displayWhen": 4,
"start": "2026-06-03T13:14:09.8437849",
"end": "2026-06-03T13:14:09.8437849",
"deleted": true,
"updated": "2026-06-03T13:14:09.8437849",
"possibleIntegerResponses": [
1,
2
],
"possibleTextResponses": [
"sample string 1",
"sample string 2"
],
"possibleGuidResponses": [
"0b041b17-5d1a-42b4-b9b3-7cea9d95cbad",
"215b3954-9bcb-4c1b-9f84-4c86e848fd95"
],
"allowsAllTextResponses": true,
"surveyForm": {
"$id": "3",
"id": 1,
"g_UID": "+O844GC7gEiqvNBJ51UYIQ==",
"guid": "e038eff8-bb60-4880-aabc-d049e7551821",
"zoneID": 3,
"storeID": 4,
"name": "sample string 5",
"formType": "sample string 6",
"locationX": 1,
"locationY": 1,
"width": 1,
"height": 1,
"maximised": true,
"resizable": true,
"backgroundImage": "sample string 7",
"backgroundColour": "sample string 8",
"backgroundColourA": 1,
"backgroundColourR": 1,
"backgroundColourG": 1,
"backgroundColourB": 1,
"fontFamily": "sample string 9",
"fontSize": 1.1,
"fontStyle": 1,
"previousForm": 1,
"previousFormG_UID": "Yl/Aeh/LYk+2DmPT0KcrGQ==",
"previousFormGuid": "7ac05f62-cb1f-4f62-b60e-63d3d0a72b19",
"nextForm": 1,
"nextFormG_UID": "XWJ94lPXFEGV6Z2D0KV1Bg==",
"nextFormGuid": "e27d625d-d753-4114-95e9-9d83d0a57506",
"attributes": "sample string 10",
"updated": "2026-06-03T13:14:09.8437849",
"positioning": 1,
"contentPanel": "sample string 11",
"selectionMode": 1,
"maximumSelections": 1,
"alteredInStore": true,
"deleted": true,
"blueprintID": 1,
"preserveLayout": true,
"mainCheckoutFormName": "sample string 13",
"nextCheckoutForm": {
"$ref": "3"
},
"previousCheckoutForm": {
"$ref": "3"
},
"buttons": [
{
"$id": "4",
"id": 1,
"checkoutFormID": 2,
"checkoutFormG_UID": "ZPnIbkK+Jk2Y0Xnv8dKVuQ==",
"checkoutFormGuid": "6ec8f964-be42-4d26-98d1-79eff1d295b9",
"identifier": "/RFhvQfAqkuLxJDljzr/4Q==",
"identifierGuid": "bd6111fd-c007-4baa-8bc4-90e58f3affe1",
"name": "sample string 5",
"plu": 1,
"locationX": 1,
"locationY": 1,
"width": 1,
"height": 1,
"anchor": 1,
"backgroundImage": "sample string 6",
"backgroundImageID": 1,
"backgroundImageUrl": "sample string 7",
"topColour": 1,
"textColour": 1,
"bottomColour": 1,
"borderColour": 1,
"borderWidth": 1,
"radius": 1,
"gradientMode": 1,
"dropShadow": true,
"shadowWidth": 1,
"highLightOnPush": true,
"fontFamily": "sample string 8",
"fontSize": 1.1,
"fontStyle": 1,
"textAlign": 1,
"imageAlign": 1,
"wordBreak": true,
"verticalText": true,
"buttonFunction": 1,
"buttonValue": 1,
"valueG_UID": "x2M5X4U3WEm7YttRxM20LA==",
"valueGuid": "5f3963c7-3785-4958-bb62-db51c4cdb42c",
"buttonText": "sample string 10",
"valueText": "sample string 11",
"drawImageAndButton": true,
"updated": "2026-06-03T13:14:09.8437849",
"action": "sample string 12",
"valueForm": {
"$ref": "3"
},
"image": {
"$id": "5",
"name": "sample string 3.sample string 4",
"imageID": 2,
"imageName": "sample string 3",
"imageExtension": "sample string 4",
"lastUpdate": "2026-06-03T13:14:09.8437849",
"imageData": "QEA=",
"readOnly": true
}
},
{
"$ref": "4"
}
],
"panels": [
{
"$id": "6",
"id": 1,
"checkoutFormID": 2,
"checkoutFormG_UID": "eG3MC58WGkaH+yDtRGupGg==",
"checkoutFormGuid": "0bcc6d78-169f-461a-87fb-20ed446ba91a",
"panelType": "sample string 4",
"name": "sample string 5",
"locationX": 6,
"locationY": 7,
"width": 8,
"height": 9,
"anchor": 10,
"fontFamily": "sample string 11",
"fontSize": 12.1,
"fontStyle": 13,
"backgroundColour": 14,
"textColour": 15,
"attributes": "sample string 16"
},
{
"$ref": "6"
}
]
}
},
{
"$ref": "2"
}
],
"skip": 1,
"take": 1,
"totalCount": 1
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Sample:
PK �i�\�~~e� 5 xl/workbook.xml � (� ����0��&�C�p�QR8q����Ri�?ik���'�x�3;�������go=����w1� Ȏ4��ud�]k��8I�۶JRe�K���&�<
�5�S.��+8O�(�aEiT���cbn�P4�ENƷ�l2XC�l�X3���F�lqnM����\M�=�(�i�I}9e��{� ��.?PK �i�\���� � [Content_Types].xml � (� ���J�0�_��*M�D��V�*��d�
�d�k��<�H���V���=
��|�o��|����������+�����7l���e۶~=E�"�zlXO�@Ճ��C�3]HNR~���R��uU�<���������a��36��b7םQ
�1Z�$�8z�R��3
tP��-c�� g����_M��Of���~O�s�T���� ����P<�D��e=1Z��a2�b
��%#H'�2}���e�B)��~j/F�t��PK
�i�\��h�' ' _rels/.rels � (� <?xml version="1.0" encoding="utf-8"?><Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"><Relationship Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="xl/workbook.xml" Id="R88b3f682229d487a" /></Relationships>PK �i�\uS�� xl/worksheets/sheet1.xml � (� ��[O�0��J�{遃�,�f��x���hF��vßo)�N�7������kH��'��PmI�!�m�J��2x�����Szoj�-pxkV:����B���d&P�Jiɬ��RU%
�Q�Q��"�q�4o�u[�Z����9h�JA6C)�D��z�h^e�����~�3�Ơ?ɛR�~�Xf{��{���%�ر�Ϫ{�bW[פ�;�j�)��A ٻw��u��pB]�U�u�L>����G'/�bL�exM�x/�����o4z�?�x���#$ !]D'����>��{�a��V�~�U�G7nh���&w����Ի#q;'�9q7'�9���9���D {�N��ә��>'��?��������6$E�:^�_��{�,��N��:� PK �i�\d��� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�����i7lؖ^������.г��H\�J�J,�t5��ӓf>�?6��id/��]��ȡ7��8%{W�n��ӨS���0G�W\l�Oi~�<bO�������a�)���ƣ�+!V<,p�d��L�!zk�G���\��_}8ƞ(;��Qj��w�E�{2
�jlKc֢��[`�fj1�G��^�|!�J�X*2��T�7��u �B���iY^�����JI�BTT_���_l� PK �i�\Ѓc'2 E
xl/styles.xml � (� �S�j�0��&0���0�^�]v��:��d;��H��Kj�vG�Mz�zOHr�iB8v �F��WEG�?s�Oh�lff�uZМ���ށh�R���6�'��2��������ɳ�UŦ`<Қo���x���8��K�6BC ^�کĖ��B���n��f8����9� ����CUk��#��U�ub��WUB;��k���&�
AR>��� ��im��ΑF���YO��%�}� ��LJ\in�,���9oy}��y.�$��6��ųNJ�c��T��rĘ)փBR淶�E3ʟ�\��q��PK �i�\��:� v xl/sharedStrings.xml � (� e�AO�0��J�;I�j�C5��儐�Z���8!v'ʯ'c ��d��z��+��މ#$�+�Q��},��|��� 68*� I��K"يTɉ9�kM�ސ
0o�!y�Y�QSL`� �;}]7��R�aF��3ڏ�?�غ�["���R��=Y�K�|��u��v�����J���]���&8=�H=B��:��y�}�֠!�6�H��F���w����\\�
PK- �i�\�~~e� 5 xl/workbook.xmlPK- �i�\���� � � [Content_Types].xmlPK-
�i�\��h�' ' U _rels/.relsPK- �i�\uS�� � xl/worksheets/sheet1.xmlPK- �i�\d��� P � xl/_rels/workbook.xml.relsPK- �i�\Ѓc'2 E
� xl/styles.xmlPK- �i�\��:� v ^ xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
Sample:
PK �i�\;�ŷ 5 xl/workbook.xml � (� ����0D�&�C���H#N\�z�^`�
�K��|�o�vfg�N>��kĞ|�`\f*�3�\#Aw�̼��j�gi_�N5Pa��`<;GQ�,�+4N��ѕ�ˍD�$��Ê�BZ��K����9[��$l
��T`�EP�
�����4��fj���Mc~K�5�������w�PK �i�\���� � [Content_Types].xml � (� ���J�0�_��*M�D��V�*��d�
�d�k��<�H���V���=
��|�o��|����������+�����7l���e۶~=E�"�zlXO�@Ճ��C�3]HNR~���R��uU�<���������a��36��b7םQ
�1Z�$�8z�R��3
tP��-c�� g����_M��Of���~O�s�T���� ����P<�D��e=1Z��a2�b
��%#H'�2}���e�B)��~j/F�t��PK
�i�\���' ' _rels/.rels � (� <?xml version="1.0" encoding="utf-8"?><Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"><Relationship Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="xl/workbook.xml" Id="R29d8cbefd1004f59" /></Relationships>PK �i�\uS�� xl/worksheets/sheet1.xml � (� ��[O�0��J�{遃�,�f��x���hF��vßo)�N�7������kH��'��PmI�!�m�J��2x�����Szoj�-pxkV:����B���d&P�Jiɬ��RU%
�Q�Q��"�q�4o�u[�Z����9h�JA6C)�D��z�h^e�����~�3�Ơ?ɛR�~�Xf{��{���%�ر�Ϫ{�bW[פ�;�j�)��A ٻw��u��pB]�U�u�L>����G'/�bL�exM�x/�����o4z�?�x���#$ !]D'����>��{�a��V�~�U�G7nh���&w����Ի#q;'�9q7'�9���9���D {�N��ә��>'��?��������6$E�:^�_��{�,��N��:� PK �i�\�~�� P xl/_rels/workbook.xml.rels � (� ��Kn�0@�b;qB� �n�R.`�q�ؑmJ9[=R�P�Jm����h~OO��|�Xo�Ɓ����
Y�rmo��Q?-a�Y�q�1M�O��01N+J�28ʐ� m�h�GS�;:Iu��E�s���g��u���ֽ�g��#���^�?����06�S
��,Q����∪全��X)4�0���_��|&�9g��������2Fzl_�O��;��3��(�.�B���nj��/6_PK �i�\Ѓc'2 E
xl/styles.xml � (� �S�j�0��&0���0�^�]v��:��d;��H��Kj�vG�Mz�zOHr�iB8v �F��WEG�?s�Oh�lff�uZМ���ށh�R���6�'��2��������ɳ�UŦ`<Қo���x���8��K�6BC ^�کĖ��B���n��f8����9� ����CUk��#��U�ub��WUB;��k���&�
AR>��� ��im��ΑF���YO��%�}� ��LJ\in�,���9oy}��y.�$��6��ųNJ�c��T��rĘ)փBR淶�E3ʟ�\��q��PK �i�\��:� v xl/sharedStrings.xml � (� e�AO�0��J�;I�j�C5��儐�Z���8!v'ʯ'c ��d��z��+��މ#$�+�Q��},��|��� 68*� I��K"يTɉ9�kM�ސ
0o�!y�Y�QSL`� �;}]7��R�aF��3ڏ�?�غ�["���R��=Y�K�|��u��v�����J���]���&8=�H=B��:��y�}�֠!�6�H��F���w����\\�
PK- �i�\;�ŷ 5 xl/workbook.xmlPK- �i�\���� � [Content_Types].xmlPK-
�i�\���' ' V _rels/.relsPK- �i�\uS�� � xl/worksheets/sheet1.xmlPK- �i�\�~�� P � xl/_rels/workbook.xml.relsPK- �i�\Ѓc'2 E
� xl/styles.xmlPK- �i�\��:� v a xl/sharedStrings.xmlPK � �