---
title: "Search for responses"
method: POST
path: "/api/v1/responses/search"
tags: ["Responses"]
---

# Search for responses

`POST /api/v1/responses/search`

## Request

- Base URL: `https://api.simplesat.io`
- URL: `https://api.simplesat.io/api/v1/responses/search`
- Auth: API key in header `X-Simplesat-Token`

Search for responses.

Required scopes: `read responses`

Accepted date filters are:
  - `created_start_date`
  - `created_end_date`
  - `modified_start_date`
  - `modified_end_date`

Accepted `comparison` values are:
  - `is`
  - `is_not`
  - `contains`
  - `does_not_contain`
  - `is_unknown`
  - `has_any_value`

Accepted `key` values are:
  - `choice_value`
  - `collaborator`
  - `company`
  - `comment`
  - `customer` (name)
  - `customer.email`
  - `ip`
  - `metric`
  - `sentiment`
  - `source`
  - `survey` (token)
  - `tag`
  - `team_member` (name)
  - `team_member.email`
  - `team_member.id` (external_id)
  - `ticket_id` (external_id)
  - `customer.attribute` (add the `attribute` field to the filter to specify the attribute to filter on)
  - `ticket.attribute` (add the `attribute` field to the filter to specify the attribute to filter on)

## Query parameters

- `page_size` integer
- `page` integer

## Request body

- object
  - `start_date` string, date-time
  - `created_start_date` string, date-time
  - `end_date` string, date-time
  - `created_end_date` string, date-time
  - `modified_start_date` string, date-time
  - `modified_end_date` string, date-time
  - `filters` object[]
    - `key` string
    - `values` string[]
    - `attribute` string
    - `comparison` string

## Response `200`

Successful response

- object
  - `next` string
  - `previous` string, nullable
  - `count` integer
  - `responses` object[]
    - `id` integer
    - `survey` object
      - `id` integer
      - `name` string
    - `tags` string[]
    - `created` string, date-time
    - `modified` string, date-time
    - `ip_address` string
    - `language` string
    - `ticket` object
      - `id` integer
      - `external_id` string
      - `subject` string
      - `custom_attributes` object
    - `team_members` object[]
      - `id` integer
      - `role` string
      - `is_primary` boolean
      - `external_id` string
      - `name` string
      - `email` string
      - `groups` TeamMemberGroup[]
        - `token` string: Unique identifier for the team member group, defined by Simplesat.
        - `name` string: The name of the team member group.
    - `customer` object
      - `id` integer
      - `external_id` string
      - `name` string
      - `email` string
      - `company` string
      - `tags` string[]
      - `custom_attributes` object
    - `answers` object[]
      - `id` integer
      - `question` object
        - `id` integer
        - `text` string
        - `metric` string
      - `choice` string
      - `choices` string[], nullable
      - `comment` string, nullable
      - `sentiment` string
      - `follow_up_answer` string
      - `choice_label` string
      - `follow_up_answer_choice` string, nullable
      - `follow_up_answer_choices` string[], nullable
      - `follow_up_question` object
        - `id` integer
        - `text` string
        - `metric` string
      - `language` string
      - `topics` Topic[]
        - `id` integer: Unique identifier for the topic, defined by Simplesat.
        - `name` string: The name of the topic.
        - `description` string: A description of the topic.
        - `sentiment` string: The sentiment associated with the topic for this answer.
    - `source` string

---

[API](https://skmtc.dev/simplesat/apis/simplesat-api-v1.md) · [All operations](https://skmtc.dev/simplesat/apis/simplesat-api-v1/llms.txt) · [OpenAPI document](https://skmtc.dev/simplesat/apis/simplesat-api-v1/revisions/1c245425416b?raw)