---
title: "Consulta Pública da Caixa de Sugestões"
method: POST
path: "/suggestions/search"
tags: ["Score"]
---

# Consulta Pública da Caixa de Sugestões

`POST /suggestions/search`

## Request body

- object
  - `startDate` string, date — Data inicial do período de consulta.
  - `endDate` string, date — Data final do período de consulta. Se não for informada, será considerada a data atual. O formato deve ser YYYY-MM-DD.
  - `offset` integer — A partir de qual sugestão deve-se pegar
  - `limit` integer — Quantidade de sugestões máxima para retorno por página. Se não for informada, será considerada como 15.
  - `unread` boolean — Quando for "true", retornará só as sugestões não lidas. Quando for "false", só as lidas. Quando não for informado, retornará lidas e não lidas.
  - `leaders` integer[] — Quando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar o id do atributo.
  - `groups` integer[] — Quando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar o id do atributo.
  - `positions` string[] — Quando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar o nome do atributo.
  - `genders` string[] — Quando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar o nome do atributo
  - `sexes` string[] — Quando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar o nome do atributo.
  - `unitBusinesses` string[] — Quando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar o nome do atributo.
  - `unitGeographies` string[] — Quando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar o nome do atributo.
  - `tags` string[] — Quando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar o nome do atributo.
  - `scholarities` string[] — Quando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar o nome do atributo.

## Response `200`

Success

- object
  - `suggestions` object[]
    - `id` string — Id de registro da sugestão.
    - `description` string — Texto da sugestão.
    - `timestamp` string, date-time — Data de envio da sugestão.
    - `unread` string — Flag que indica status de leitura (Lido = “0"/ Não lido = “1").
    - `subject` object — Objeto com o nome da categoria da sugestão em diferentes linguagens.
      - `en-US` string
      - `es-ES` string
      - `pt-BR` string
    - `respondent` string — Em caso de ser um envio confidencial, virá como “Confidential". Se não, virá o nome do respondente.
    - `answer` string, nullable — Texto da resposta para aquela sugestão.
    - `answeredAt` string, date-time, nullable — Data de envio da resposta.
  - `code` integer — Pode ser 1 em caso de sucesso e 0 em caso de erro.
  - `page` object
    - `actualPage` integer — Página consultada atualmente
    - `limit` integer — Quantidade de sugestões por página

## Other responses

- `400` — Cliente aplicou um filtro sem o mínimo de respondentes configurado na aplicação
- `403` — Módulo Suggestion Box não disponível ou token errado
- `404` — Filtro sem comentários achados

---

[API](https://skmtc.net/gupy/apis/gupy-public-api.md) · [All operations](https://skmtc.net/gupy/apis/gupy-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gupy/gupy-public-api/revisions/3f26defa2a42/schema)