Listar o status de envio de um comunicado para um cliente

Permite obter a situação de envio de um comunicado para os contatos de um cliente específico vinculado a um escritório contábil.

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

Request

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

Path parameters

accountingFirmIdstring required

Id do escritório.

announcementIdstring required

Id do comunicado.

customerIdstring required

Id do cliente.

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

namestring

documentNumberstring

Example response

{
  "id": "id",
  "name": "string",
  "documentNumber": "string",
  "contacts": [
    {
      "id": "id",
      "name": "string",
      "email": "string",
      "emailSentDate": "2025-05-14T18:06:22.538Z"
    }
  ]
}

Changes

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