PicChat

Notas

Listar notas

GEThttps://api.picchat.com.br/v1/notes

Lista as notas internas dos tíquetes, ordenadas por created_at decrescente por padrão. Filtra por tíquete, contato, canal, texto e período. Usuário restrito a canais só vê notas desses canais.

Autenticação: Bearer tokenPermissão: Inbox › ver

Parâmetros de consulta (query)

  • pageintegerpadrão 1

    Página, começando em 1. Valor ausente, inválido ou menor que 1 vira 1.

  • limitintegerpadrão 20

    Itens por página. Padrão 20, máximo 100: acima disso é reduzido para 100 sem erro; valor inválido ou menor que 1 vira 20.

  • ticket_idstring (uuid)

    Só notas deste tíquete.

  • contact_idstring (uuid)

    Só notas deste contato.

  • channel_idstring (uuid)

    Só notas deste canal. Usuário com grupo de permissão e vinculado a canais só vê os desses canais; `channel_id` fora do escopo → 403 `channel_out_of_scope`.

  • searchstring

    Busca parcial no texto, sem diferenciar maiúsculas.

  • fromstring

    Início do período por `created_at` (inclusive), em ISO 8601 (`2026-09-01` ou `2026-09-01T03:00:00Z`). Só a data = 00:00 UTC. Valor inválido → 400.

  • tostring

    Fim do período por `created_at` (inclusive), em ISO 8601. Só a data inclui o dia inteiro (até 23:59:59.999 UTC). Valor inválido → 400.

  • orderstringpadrão "desc"

    Direção da ordenação por `created_at`. Qualquer outro valor usa o padrão.

Respostas

200OK

  • itemsarray<Note>obrigatório

    Registros da página.

  • items[].idstring (uuid)obrigatório

    ID da nota.

  • items[].ticket_idstring (uuid) | nullobrigatório

    Tíquete da nota.

  • items[].contact_idstring (uuid) | nullobrigatório

    Contato.

  • items[].channel_idstring (uuid)obrigatório

    Canal.

  • items[].bodystring | nullobrigatório

    Texto da nota.

  • items[].filestring | nullobrigatório

    URL de anexo.

  • items[].captionstring | nullobrigatório

    Legenda do anexo.

  • items[].sent_atstring (date-time)obrigatório

    Quando foi registrada.

  • items[].created_atstring (date-time)obrigatório

    Criação.

  • items[].usersobjectobrigatório

    Usuário (atendente) resumido.

  • items[].users.idstring (uuid)obrigatório

    ID do usuário.

  • items[].users.namestringobrigatório

    Nome.

  • items[].users.lastNamestring | nullobrigatório

    Sobrenome.

  • totalintegerobrigatório

    Total de registros que casam com os filtros (todas as páginas).

  • pageintegerobrigatório

    Página devolvida (começa em 1).

  • limitintegerobrigatório

    Itens por página efetivamente usados (1–100).

  • pagesintegerobrigatório

    Total de páginas: `max(1, ceil(total / limit))`. Nunca é 0, mesmo sem resultados.

400Parâmetro de data (`from`, `to`, `updated_from`, `updated_to`) fora do formato ISO 8601.

403Acesso negado: usuário do token sem a permissão da rota (`permission_denied`) ou token não ligado a um usuário ativo (`token_without_user`) — para token de integração da conta isso só é aplicado quando `access.enforced` é true (veja GET /v1/me); token pessoal e JWT de sessão são sempre verificados; `channel_id` fora dos canais do usuário (`channel_out_of_scope`); `account_id` na query diferente da conta do token; conta do tipo INFRA.

498Token ausente, inválido, de outra finalidade (ex.: token do canal chat) ou revogado. Note o status não padrão 498.