Skip to main content

List of all surveys

This endpoint retrieves all your surveys.

Request​

GET https://api.nicereply.com/surveys

By default, list of surveys is sorted by created_at.

Query Parameters​

Pagination is supported.

ParameterRequiredDefaultDescription
sort_orderNodescValid values is: asc or desc.

Example response​

200 OK
{
  "data": [
    {
      "id": "4e25a8aa-c810-49ae-95c3-01e03ac07e37",
      "name": "Help Desk survey",
      "distribution": "TEMPLATE",
      "integration_id": "2f83d275-374d-45ea-b2e8-674942026ba8",
      "is_archived": false,
      "created_at": "2023-09-26T10:46:55+02:00",
      "updated_at": "2023-09-26T10:46:55+02:00",
      "ticket_link": "https://nicereply.platform.tld/agent/#/tickets/<TICKET_ID>",
      "questions": [
         {
           "question_id": "17762183-8c94-40e5-8e2f-e4a12eaeefb4",
           "position": 1,
           "is_required": true,
           "is_active": true,
           "is_main": true,
           "is_legacy_comment": false
         }
      ]
    },
    {
      "id": "9df60603-9453-41a2-a938-436fd603820d",
      "name": "Sign up survey",
      "distribution": "TEMPLATE",
      "integration_id": "2f83d275-374d-45ea-b2e8-674942026ba8",
      "is_archived": false,
      "created_at": "2023-09-06T13:01:42+02:00",
      "updated_at": "2023-09-07T14:14:50+02:00",
      "ticket_link": "",
      "questions": [
        {
          "question_id": "7a9ecf44-dfe1-4f7f-8f99-c612cd815033",
          "position": 1,
          "is_required": true,
          "is_active": true,
          "archived_at": null,
          "is_main": true,
          "is_legacy_comment": false
        },
        {
          "question_id": "6d04f350-a7c3-4b7e-a6e8-6b129d79933f",
          "position": 2,
          "is_required": false,
          "is_active": false,
          "archived_at": "2023-09-07T14:14:50+02:00",
          "is_main": false,
          "is_legacy_comment": false
        }
      ]
    }
    // ...
  ],
  "pagination": {
    "total": 30,
    "count": 10,
    "per_page": 10,
    "current_page": 1,
    "total_pages": 3,
    "links": {
      "next": "/surveys?page=2",
      "prev": null
    }
  }
}