GET api/surveys

Request Information

URI Parameters

NameDescriptionTypeAdditional 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
NameDescriptionTypeAdditional 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": "ZrZYUBm9S0OnaGNdtXnV1w==",
      "guid": "5058b666-bd19-434b-a768-635db579d5d7",
      "name": "sample string 1",
      "storeID": 2,
      "zoneID": 1,
      "checkoutFormG_UID": "tJfvjrzK/kabM/v9680Khg==",
      "checkoutFormGuid": "8eef97b4-cabc-46fe-9b33-fbfdebcd0a86",
      "displayToWho": 3,
      "displayWhen": 4,
      "start": "2026-04-03T06:27:09.6818071",
      "end": "2026-04-03T06:27:09.6818071",
      "deleted": true,
      "updated": "2026-04-03T06:27:09.6818071",
      "possibleIntegerResponses": [
        1,
        2
      ],
      "possibleTextResponses": [
        "sample string 1",
        "sample string 2"
      ],
      "possibleGuidResponses": [
        "2c2426b3-b038-49a4-9b69-2453a9e8316f",
        "252cf5f2-febd-4d35-ba02-76d9a70c573d"
      ],
      "allowsAllTextResponses": true,
      "surveyForm": {
        "$id": "3",
        "id": 1,
        "g_UID": "dU3hHaQ3xE+AHYqDhUBQCA==",
        "guid": "1de14d75-37a4-4fc4-801d-8a8385405008",
        "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": "AUVCZaDZe02pbmp+oTMH3g==",
        "previousFormGuid": "65424501-d9a0-4d7b-a96e-6a7ea13307de",
        "nextForm": 1,
        "nextFormG_UID": "IZ4OH4h0tkO8gDoUJ51q/A==",
        "nextFormGuid": "1f0e9e21-7488-43b6-bc80-3a14279d6afc",
        "attributes": "sample string 10",
        "updated": "2026-04-03T06:27:09.6818071",
        "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": "hVNkZsVOZEKo0iCkQwkC1Q==",
            "checkoutFormGuid": "66645385-4ec5-4264-a8d2-20a4430902d5",
            "identifier": "7kc3ceMkEU+7FcM/MFgdjw==",
            "identifierGuid": "713747ee-24e3-4f11-bb15-c33f30581d8f",
            "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": "98oi1w8NYE+WzV8Cg7LVQA==",
            "valueGuid": "d722caf7-0d0f-4f60-96cd-5f0283b2d540",
            "buttonText": "sample string 10",
            "valueText": "sample string 11",
            "drawImageAndButton": true,
            "updated": "2026-04-03T06:27:09.6818071",
            "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-04-03T06:27:09.6818071",
              "imageData": "QEA=",
              "readOnly": true
            }
          },
          {
            "$ref": "4"
          }
        ],
        "panels": [
          {
            "$id": "6",
            "id": 1,
            "checkoutFormID": 2,
            "checkoutFormG_UID": "NjAo+kNcRkuEiA4ISrdi6Q==",
            "checkoutFormGuid": "fa283036-5c43-4b46-8488-0e084ab762e9",
            "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:
PKd3�\L��d�5xl/workbook.xml �(�����0��&�C��`�D��x��}��4Пtk��H�yۙ��v����i��>z4T���!�Bj{�@'���;i��0K�VJ�bc۷F�9Ir�q����^9�+�9��Q���4(��ぱri�P8Q����]L&֐�M��_D�h�x8�έ�xʙ/�<�e�e�ʋ��6y�;{��b�]PKd3�\����	�[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
d3�\�s''_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="Re56cdbf33dd0442c" /></Relationships>PKd3�\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��:�PKd3�\���Pxl/_rels/workbook.xml.rels �(���KN�0@�b͞�)nҠ�ݰa[z��3�DM��v���G�
XT�Tb�������4����޾��x!zgk�3��qMo�N��V�ݬw4`L�� Ҋ
5t1NR�ш!s��a�G�)�����%�P��~΀k�؟'��1���9�d�`���1tD�}K���R��!��SSÎ�1�%��h�
���Z��¯�%���ɋU��e��=�T�CO�s���s�yy�V.ذf�4�EM^���PKd3�\Ѓc'2E
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��PKd3�\��:�vxl/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-d3�\L��d�5xl/workbook.xmlPK-d3�\����	��[Content_Types].xmlPK-
d3�\�s''U_rels/.relsPK-d3�\uS���xl/worksheets/sheet1.xmlPK-d3�\���P�xl/_rels/workbook.xml.relsPK-d3�\Ѓc'2E
�xl/styles.xmlPK-d3�\��:�v^xl/sharedStrings.xmlPK��	

application/vnd.ms-excel

Sample:
PKd3�\tG��5xl/workbook.xml �(�����0��&�C�p���x��}��m�-ik���'�x�3;���u]mm�>�7>s�!�o$i�';��v�:�a��V�Pe��& ��8�1(k�T��+��a�%Q���Ҩ/����S��9[��d���7�/��bQ̠��W��Ź��9s�����k�Tǔ&�4�����a9l��/PKd3�\����	�[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
d3�\k댾''_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="R42056c0d65e449ad" /></Relationships>PKd3�\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��:�PKd3�\	�P�Pxl/_rels/workbook.xml.rels �(���KN�0@�b͞رP�n�t[z�L⨉�n�gc���V� �X��j4��'�|��6o�HN��]e���3�\��1uw5l֫�:�h�9���b6����h,N:~F�;��N9
=��9�)gLѰd�5���3���n0���qB���W�"& {zL
��"����T ۶�]��[�/%J^K�z3���#�_��|!��Ճ��R"�7��:`��B���iY^���!/+aj�$G}Q�W��PKd3�\Ѓc'2E
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��PKd3�\��:�vxl/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-d3�\tG��5xl/workbook.xmlPK-d3�\����	��[Content_Types].xmlPK-
d3�\k댾''U_rels/.relsPK-d3�\uS���xl/worksheets/sheet1.xmlPK-d3�\	�P�P�xl/_rels/workbook.xml.relsPK-d3�\Ѓc'2E
�xl/styles.xmlPK-d3�\��:�v_xl/sharedStrings.xmlPK��