v1

latestOpenAPI 3.0.02026-07-24161168406.5 KB

Score

Consulta Pública da Caixa de Sugestões

post/suggestions/search

Request body

startDatestring date

Data inicial do período de consulta.

endDatestring 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.

offsetinteger

A partir de qual sugestão deve-se pegar

limitinteger

Quantidade de sugestões máxima para retorno por página. Se não for informada, será considerada como 15.

unreadboolean

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.

leadersinteger[]

Quando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar o id do atributo.

groupsinteger[]

Quando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar o id do atributo.

positionsstring[]

Quando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar o nome do atributo.

gendersstring[]

Quando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar o nome do atributo

sexesstring[]

Quando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar o nome do atributo.

unitBusinessesstring[]

Quando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar o nome do atributo.

unitGeographiesstring[]

Quando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar o nome do atributo.

tagsstring[]

Quando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar o nome do atributo.

scholaritiesstring[]

Quando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar o nome do atributo.

Example request

{
  "startDate": "2024-09-01",
  "endDate": "2024-09-30",
  "offset": 1,
  "limit": 3,
  "leaders": [
    54333
  ],
  "groups": [
    3242
  ],
  "positions": [
    "Analista de Segurança"
  ],
  "genders": [
    "Cisgênero"
  ],
  "sexes": [
    "F"
  ],
  "unitBusinesses": [
    "Tecnologia"
  ],
  "unitGeographies": [
    "Rio de Janeiro"
  ],
  "tags": [
    "CLT"
  ],
  "scholarities": [
    "Ensino Médio Completo"
  ]
}

Response

Success

codeinteger

Pode ser 1 em caso de sucesso e 0 em caso de erro.

Example response

{
  "suggestions": [
    {
      "id": "327391",
      "description": "Teste",
      "timestamp": "2025-02-03 14:21:16",
      "unread": "1",
      "subject": {
        "pt-BR": "Bem-estar"
      },
      "respondent": "Confidencial",
      "answer": "Obrigado pela sugestão!",
      "answeredAt": "2025-02-03 14:21:16"
    }
  ],
  "code": 1,
  "page": {
    "actualPage": 1,
    "limit": 1
  }
}