API Reference

Listar comunicados

get
https://api.nibo.com.br/accountant/api/v1/accountingfirms//announcements

Permite obter uma lista paginada de até 100 comunicados vinculados a um escritório contábil, com suporte a OData.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Dicionário para propriedades retornadas

Response body

  • id - Id do comunicado.
  • subject - Assunto do comunicado.
  • totalCustomers - Quantidade de clientes que receberam o comunicado.
  • totalVisualizedCustomers - Quantidade de clientes com ao menos um contato que visualizou o comunicado.
  • createdAt - Data de criação do comunicado.
  • createdBy - Nome do usuário que criou o comunicado.
Path Params
string
required

Id do escritório.

Query Params
string

Filtra os resultados com base em critérios específicos. Exemplo: filter=Name eq 'Usuário X'.

string

Define o número de resultados a serem ignorados. Exemplo: skip=10.

string

Limita o número de resultados retornados. Exemplo: top=5.

string

Ordena os resultados. Exemplo: orderby=Name asc.

Headers
string

Requer autenticação via API Key no header da requisição. Exemplo: X-API-Key: Sua chave.

string

Requer autenticação via Id do usuário no header da requisição. Exemplo: X-User-Id: Id do usuário.

Responses

Updated about 9 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 9 hours ago

Did this page help you?