NInibo

Listar um comunicado específico

Permite obter um comunicado específico vinculado a um escritório contábil.

get/v1/accountingfirms/{accountingFirmId}/announcements/{announcementId}

Request

  • Base URL
    https://api.nibo.com.br/accountant/api
  • URL
    https://api.nibo.com.br/accountant/api/v1/accountingfirms/{accountingFirmId}/announcements/{announcementId}
  • Auth
    none required

Path parameters

accountingFirmIdstring required

Id do escritório.

announcementIdstring required

Id do comunicado.

Headers

X-API-Keystring

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

X-User-Idstring

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

Response

200

idstring
subjectstring
messagestring
isReadConfirmationRequiredboolean
createdAtstring
createdBystring
totalCustomersinteger
totalSentEmailsinteger
totalOpenedCustomersinteger
totalVisualizedCustomersinteger

Example response

{
  "id": "id",
  "subject": "string",
  "message": "string",
  "createdAt": "2025-05-14T18:06:22.538Z",
  "createdBy": "string",
  "files": [
    {
      "id": "id",
      "name": "string"
    }
  ],
  "customers": [
    {
      "id": "id",
      "name": "string"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.