---
title: "Search answers"
method: POST
path: "/api/v1/answers/search"
tags: ["Answers"]
---

# Search answers

`POST /api/v1/answers/search`

## Request

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

Search for answers.

Required scopes: `read answers`

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

Accepted `key` values are:
- `choice_value`
- `comment`
- `metric`
- `sentiment`
- `survey` (token)

## Query parameters

- `page` integer
- `page_size` integer

## Request body

- object
  - `start_date` string, date-time
  - `end_date` string, date-time
  - `filters` object[]
    - `key` string
    - `values` string[]
    - `comparison` string

## Response `200`

Successful response

- object
  - `next` string, nullable
  - `previous` string, nullable
  - `count` integer
  - `answers` object[]
    - `id` integer
    - `choice` string
    - `choice_label` string
    - `choices` string[]
    - `comment` string
    - `follow_up_answer` string
    - `follow_up_answer_choice` string
    - `follow_up_answer_choices` string[]
    - `published_as_testimonial` boolean
    - `created` string, date-time
    - `modified` string, date-time
    - `question` object
      - `id` integer
      - `text` string
      - `metric` string
    - `sentiment` string
    - `survey` object
      - `id` integer
      - `name` string
    - `response_id` integer
    - `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.
  - `id` integer
  - `choice` string
  - `choice_label` string
  - `choices` string[], nullable
  - `comment` string, nullable
  - `follow_up_answer` string, nullable
  - `follow_up_answer_choice` string, nullable
  - `follow_up_answer_choices` string[], nullable
  - `published_as_testimonial` boolean
  - `created` string, date-time
  - `modified` string, date-time
  - `question` object
    - `id` integer
    - `text` string
    - `metric` string
  - `sentiment` string
  - `survey` object
    - `id` integer
    - `name` string
  - `response_id` integer
  - `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.

---

[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)