latestOpenAPI 3.0.12026-08-1914141.6 MB

c656412a58bc

Apontamentos

Listar apontamentos (global)

Lista os apontamentos de todos os tickets da organização, com filtros por usuário, mesas e período.

get/appointments

Query parameters

offsetinteger

Número da página a ser retornada

limitinteger

Número de itens retornados na página

user_idsinteger[]

Filtrar pelos IDs dos usuários que realizaram os apontamentos, separados por vírgula (,) e sem espaços: user_ids=1,2,3

  • O número máximo de itens permitidos é 15.

  • Valores duplicados não são permitidos.

  • Requer a permissão <span style="margin:1px; padding:1px 8px; font-weight:bold; border-radius:12px; background-color: var(--light-red, var(--input-bg)); color:var(--red); border:1px solid var(--red)"><!--?lit$8458964218$-->Visualizar usuários nos relatórios de atendentes</span>. Sem essa permissão, este parâmetro é ignorado e a listagem retorna sempre apenas os apontamentos do próprio usuário autenticado, independente do valor informado.

desk_idsinteger[]

Filtrar apontamentos pelas mesas dos tickets vinculados, separados por vírgula (,) e sem espaços: desk_ids=1,2,3

  • O número máximo de itens permitidos é 15.

  • Valores duplicados não são permitidos.

start_datestring date required

Retorna os apontamentos realizados a partir dessa data. Obrigatório nesta rota.

end_datestring date required

Retorna os apontamentos realizados até essa data. Obrigatório nesta rota.

include_valorizationboolean

Com esse parâmetro é possível incluir as informações de valorização de cada apontamento. Ao informar esse parâmetro como true, será adicionado um atributo de nome valorization no corpo da resposta dessa requisição. Por padrão (false), o campo valorization não é retornado.

Response

idinteger required

Identificador do apontamento

datestring date required

Dia em que o atendimento foi realizado

init_timestring required

Horário de início do atendimento. No formato HH:MM

end_timestring required

Horário de fim do atendimento. No formato HH:MM

descriptionstring required

Descrição do apontamento

external_user_namestring nullable

Nome do usuário que executou a ação em uma ferramenta externa