Listar histórico de mensagens do atendimento

Permite obter uma lista paginada de até 100 mensagens de um atendimento vinculado a um escritório contábil, em ordem de envio, com suporte a OData.

get/v1/accountingfirms/{accountingFirmId}/servicedeskrequests/{serviceDeskRequestId}/messages

Request

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

Path parameters

accountingFirmIdstring required

Id do escritório.

serviceDeskRequestIdstring required

Id do atendimento.

Query parameters

$filterstring

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

$skipstring

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

$topstring

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

$orderbystring

Ordena os resultados. Exemplo: orderby=Name asc.

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

Example response

{
  "items": [
    {
      "id": "id",
      "authorName": "string",
      "message": "string",
      "sentAt": "2025-05-14T18:06:22.538Z",
      "editedAt": "2025-05-14T18:06:22.538Z",
      "deletedAt": "2025-05-14T18:06:22.538Z"
    }
  ],
  "metadata": {
    "totalAllItems": "int",
    "total": "int"
  }
}

Changes

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