Skip to main content
GET
Listar comunicados

Authorizations

Authorization
string
header
required

Token gerado na Gestão de Tokens v2 do SULTS. Deve ser enviado no cabeçalho Authorization de todas as requisições.

Query Parameters

id
integer

Código do comunicado.

categoryId
integer

Código da categoria do comunicado.

createdByUserId
integer

Código do usuário que criou o comunicado.

active
boolean
default:true

Filtra por situação: true (padrão) traz os comunicados ativos, false traz os inativos.

page
integer
default:0

Número da página da listagem, começando em 0. Incremente até a resposta vir vazia.

Required range: x >= 0

Response

Lista de comunicados.

id
integer

Código do comunicado.

Example:

18

title
string

Título do comunicado.

Example:

"Resultados do marketing"

category
object

Categoria do comunicado.

createdByUser
object

Usuário em forma resumida.

createdAt
string<date-time>

Data de criação, em UTC ISO 8601.

Example:

"2026-08-06T19:30:57Z"

publishStartDate
string<date> | null

Data de início da publicação, no formato yyyy-MM-dd.

Example:

"2026-08-06"

publishEndDate
string<date> | null

Data de fim da publicação. Nulo quando o comunicado não tem prazo para sair do ar.

Example:

null

visibilityRoleType
enum<string>[]

Perfis que enxergam o comunicado.

Available options:
ADMIN,
COMPANY
Example:
required
boolean

Indica se a leitura exige aceite do destinatário.

Example:

true

active
boolean

Indica se o comunicado está ativo.

Example:

true

sendEmail
boolean

Indica se o comunicado também é enviado por e-mail.

Example:

true

emailWithContent
boolean

Indica se o e-mail leva o conteúdo completo do comunicado.

Example:

false