---
updatedAt: 2025-09-24T20:45:11.000Z
agentTools:
  projectIndex: https://docs.smartsurvey.io/v1/llms.txt
---

# responses

## Answer Choice Fields

The answers property can contain the following fields:

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>

      </th>

      <th>

      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        <code>id</code>
      </td>

      <td>
        ID of answer
      </td>
    </tr>

    <tr>
      <td>
        <code>type</code>
      </td>

      <td>
        Type of answer
      </td>
    </tr>

    <tr>
      <td>
        <code>choice\_title</code>
      </td>

      <td>
        Label of the choice selected
      </td>
    </tr>

    <tr>
      <td>
        <code>choice\_id</code>
      </td>

      <td>
        ID of the choice selected
      </td>
    </tr>

    <tr>
      <td>
        <code>row\_title</code>
      </td>

      <td>
        Label of the row selected in a matrix
      </td>
    </tr>

    <tr>
      <td>
        <code>row\_id</code>
      </td>

      <td>
        ID of the row selected
      </td>
    </tr>

    <tr>
      <td>
        <code>column\_title</code>
      </td>

      <td>
        Label of the column in a matrix
      </td>
    </tr>

    <tr>
      <td>
        <code>column\_id</code>
      </td>

      <td>
        ID of the column selected
      </td>
    </tr>

    <tr>
      <td>
        <code>dropdown\_title</code>
      </td>

      <td>
        Label of the drop down choice in Drop Down Matrix.
      </td>
    </tr>

    <tr>
      <td>
        <code>dropdown\_id</code>
      </td>

      <td>
        ID of the column selected
      </td>
    </tr>

    <tr>
      <td>
        <code>value</code>
      </td>

      <td>
        Open-ended text value
      </td>
    </tr>
  </tbody>
</Table>

## Sort By Multiple Fields

To sort by multiple fields, you can add the "sort\_by" parameter more than once in the query. The following URL

```toml URL
https://api.smartsurvey.io/v1/surveys?sort_by=title,asc&sort_by=date_created,desc
```

## Filter by date

The date format for the <code>since</code> filter must be a Unix Epoch timestamp.

**So for example:**\
Sun, 04 Dec 2016 08:16:41 GMT

**The Unix Epoch timestamp is:**\
1480839401

**Example request:**\ <span>ht</span>tps\://api.smartsurvey.io/v1/surveys/123123/responses?completed=1\&since=1480839401\&include\_labels=false

You can use the following site to see how the conversion works:\
<http://www.epochconverter.com/>

## Parameters

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "api-settings",
    "version": "1"
  },
  "servers": [
    {
      "url": "https://api.smartsurvey.io/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/surveys/{survey_id}/responses": {
      "get": {
        "summary": "responses",
        "description": "",
        "operationId": "get-responses",
        "parameters": [
          {
            "name": "completed",
            "in": "query",
            "description": "0=Partial, 1=Completed, 2=Both - Return completed responses or partial.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 1
            }
          },
          {
            "name": "since",
            "in": "query",
            "description": "Return responses that completed no earlier than this Unix epoch timestamp",
            "schema": {
              "type": "integer",
              "format": "int64",
              "default": 0
            }
          },
          {
            "name": "until",
            "in": "query",
            "description": "Return responses that completed no later than this Unix epoch timestamp",
            "schema": {
              "type": "integer",
              "format": "int64",
              "default": 0
            }
          },
          {
            "name": "filter_id",
            "in": "query",
            "description": "Enter the filter report ID you would like to use. Other filters will be ignored.",
            "schema": {
              "type": "integer",
              "format": "int64",
              "default": 0
            }
          },
          {
            "name": "tracking_link_id",
            "in": "query",
            "description": "Filter by tracking link id",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "unique_id",
            "in": "query",
            "description": "Filter the unique (x) value",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "include_labels",
            "in": "query",
            "description": "Return text of page/question/choice labels, rather than indices only",
            "schema": {
              "type": "boolean",
              "default": false
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Which page to return.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 1
            }
          },
          {
            "name": "page_size",
            "in": "query",
            "description": "Number of rows to return per page",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 10
            }
          },
          {
            "name": "sort_by",
            "in": "query",
            "description": "Field used to sort returned survey list: ‘date_started’, ‘date_ended’ or 'date_modified’. Add a comma and 'asc' or 'desc' to specify the sort order.",
            "schema": {
              "type": "string",
              "default": "date_ended,desc"
            }
          },
          {
            "name": "sort_by",
            "in": "query",
            "description": "You can add more than one sort_by to the querystring to sort by multiple fields.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "survey_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "[\n  {\n    \"id\": 12345,\n    \"survey_id\": 12345,\n    \"tracking_link_id\": 12345,\n    \"translation_id\": 12345,\n    \"date_started\": \"2016-05-30T15:53:10Z\",\n    \"date_ended\": \"2016-05-30T15:53:24Z\",\n    \"date_modified\": \"2016-05-30T15:53:24Z\",\n    \"status\": \"completed\",\n    \"contact_name\": \"test\",\n    \"contact_email\": \"test@domain.com\",\n    \"contact_invitation_id\": 12345,\n    \"ip_address\": \"1.1.1.1\",\n    \"user_agent\": \"Mozilla/5.0 (Windows NT 6.1; WOW64) Chrome/50.0.2661.102 Safari/537.36\",\n    \"country\": \"0\",\n    \"entry_url\": \"http://www.smartsurvey.co.uk/s/sample_survey/\",\n    \"referer_url\": \"\",\n    \"edit_url\": \"http://www.smartsurvey.co.uk/s/sample_survey/?uid=123&edit=abcdef\",\n    \"saved\": false,\n    \"saved_name\": \"\",\n    \"saved_email\": \"\",\n    \"saved_continue_url\": \"\",\n    \"current_page_id\": 741654,\n    \"manual_entry\": false,\n    \"href\": \"https://api.smartsurvey.io/v1/surveys/12345/responses/12345\",\n    \"contact_data\": [\n      {\n      \t\"name\" : \"dob\",\n        \"value\" : \"02/03/1987\"\n      }\n    ],\n    \"variables\": [\n      {\n        \"id\" : 10001,\n      \t\"name\" : \"a\",\n        \"label\" : \"Age\",\n        \"value\" : \"30\"\n      }\n    ],\n    \"pages\": [\n      {\n        \"id\": 12345,\n        \"title\": \"Contact Details Page\",\n        \"position\": 1,\n        \"questions\": [\n          {\n            \"id\": 3093118,\n            \"title\": \"Please complete the following:\",\n            \"type\": \"open_ended\",\n            \"sub_type\": \"multi\",\n            \"position\": 1,\n            \"answers\": [\n              {\n                \"id\": 380000354,\n                \"type\": \"text\",\n                \"choice_title\": \"First Name:\",\n                \"choice_id\": 26099890,\n                \"value\": \"John\"\n              },\n              {\n                \"id\": 380000355,\n                \"type\": \"text\",\n                \"choice_title\": \"Surname:\",\n                \"choice_id\": 26099891,\n                \"value\": \"Smith\"\n              }\n            ]\n          }\n        ]\n      }\n    ]\n  }\n]"
                  }
                },
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "integer",
                        "example": 12345,
                        "default": 0
                      },
                      "survey_id": {
                        "type": "integer",
                        "example": 12345,
                        "default": 0
                      },
                      "tracking_link_id": {
                        "type": "integer",
                        "example": 12345,
                        "default": 0
                      },
                      "translation_id": {
                        "type": "integer",
                        "example": 12345,
                        "default": 0
                      },
                      "date_started": {
                        "type": "string",
                        "example": "2016-05-30T15:53:10Z"
                      },
                      "date_ended": {
                        "type": "string",
                        "example": "2016-05-30T15:53:24Z"
                      },
                      "date_modified": {
                        "type": "string",
                        "example": "2016-05-30T15:53:24Z"
                      },
                      "status": {
                        "type": "string",
                        "example": "completed"
                      },
                      "contact_name": {
                        "type": "string",
                        "example": "test"
                      },
                      "contact_email": {
                        "type": "string",
                        "example": "test@domain.com"
                      },
                      "contact_invitation_id": {
                        "type": "integer",
                        "example": 12345,
                        "default": 0
                      },
                      "ip_address": {
                        "type": "string",
                        "example": "1.1.1.1"
                      },
                      "user_agent": {
                        "type": "string",
                        "example": "Mozilla/5.0 (Windows NT 6.1; WOW64) Chrome/50.0.2661.102 Safari/537.36"
                      },
                      "country": {
                        "type": "string",
                        "example": "0"
                      },
                      "entry_url": {
                        "type": "string",
                        "example": "http://www.smartsurvey.co.uk/s/sample_survey/"
                      },
                      "referer_url": {
                        "type": "string",
                        "example": ""
                      },
                      "edit_url": {
                        "type": "string",
                        "example": "http://www.smartsurvey.co.uk/s/sample_survey/?uid=123&edit=abcdef"
                      },
                      "saved": {
                        "type": "boolean",
                        "example": false,
                        "default": true
                      },
                      "saved_name": {
                        "type": "string",
                        "example": ""
                      },
                      "saved_email": {
                        "type": "string",
                        "example": ""
                      },
                      "saved_continue_url": {
                        "type": "string",
                        "example": ""
                      },
                      "current_page_id": {
                        "type": "integer",
                        "example": 741654,
                        "default": 0
                      },
                      "manual_entry": {
                        "type": "boolean",
                        "example": false,
                        "default": true
                      },
                      "href": {
                        "type": "string",
                        "example": "https://api.smartsurvey.io/v1/surveys/12345/responses/12345"
                      },
                      "contact_data": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "name": {
                              "type": "string",
                              "example": "dob"
                            },
                            "value": {
                              "type": "string",
                              "example": "02/03/1987"
                            }
                          }
                        }
                      },
                      "variables": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "integer",
                              "example": 10001,
                              "default": 0
                            },
                            "name": {
                              "type": "string",
                              "example": "a"
                            },
                            "label": {
                              "type": "string",
                              "example": "Age"
                            },
                            "value": {
                              "type": "string",
                              "example": "30"
                            }
                          }
                        }
                      },
                      "pages": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "integer",
                              "example": 12345,
                              "default": 0
                            },
                            "title": {
                              "type": "string",
                              "example": "Contact Details Page"
                            },
                            "position": {
                              "type": "integer",
                              "example": 1,
                              "default": 0
                            },
                            "questions": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "integer",
                                    "example": 3093118,
                                    "default": 0
                                  },
                                  "title": {
                                    "type": "string",
                                    "example": "Please complete the following:"
                                  },
                                  "type": {
                                    "type": "string",
                                    "example": "open_ended"
                                  },
                                  "sub_type": {
                                    "type": "string",
                                    "example": "multi"
                                  },
                                  "position": {
                                    "type": "integer",
                                    "example": 1,
                                    "default": 0
                                  },
                                  "answers": {
                                    "type": "array",
                                    "items": {
                                      "type": "object",
                                      "properties": {
                                        "id": {
                                          "type": "integer",
                                          "example": 380000354,
                                          "default": 0
                                        },
                                        "type": {
                                          "type": "string",
                                          "example": "text"
                                        },
                                        "choice_title": {
                                          "type": "string",
                                          "example": "First Name:"
                                        },
                                        "choice_id": {
                                          "type": "integer",
                                          "example": 26099890,
                                          "default": 0
                                        },
                                        "value": {
                                          "type": "string",
                                          "example": "John"
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```