latestOpenAPI 3.0.12026-08-1914141.6 MB

c656412a58bc

Tickets

Listar tickets

Lista os tickets em sua organização, retornando apenas informações básicas dos tickets. Para obter detalhes completos sobre um ticket específico, utilize a requisição Exibir ticket.

Campos Personalizados

  • Por padrão, os campos personalizados dos tickets não serão exibidos nessa requisição
  • Para incluí-los, utilize o parâmetro include_filled_entity=true.
  • O uso de include_filled_entity não é compatível com tickets fechados (filter_by=closed ou filter_by=all), uma vez que não é permitido listar campos personalizados de tickets fechados.
  • Ao utilizar esse parâmetro, será adicionado um atributo de nome entity_fields na resposta dessa requisição. Contendo a lista de campos personalizados que estão vinculados no ticket e possuem valores preenchidos.

OBS: Essa rota só irá listar os tickets que o seu usuário possui acesso.

get/tickets

Query parameters

offsetinteger

Número da página a ser retornada

limitinteger

Número de itens retornados na página

filter_by'open' | 'closed' | 'all'

Filtrar tickets por status de abertura/fechamento. Quando informado, o parâmetro is_closed é ignorado.

desk_idsinteger[]

Filtrar tickets por mesas de serviço.

  • Deve ser informado uma lista com os IDs das mesas, 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.

client_idsinteger[]

Filtrar tickets por clientes.

  • Deve ser informado uma lista com os IDs dos clientes, separados por vírgula (,) e sem espaços: client_ids=1,2,3

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

  • Valores duplicados não são permitidos.

responsible_idsinteger[]

Filtrar tickets pelos usuários responsáveis.

  • Deve ser informado uma lista com os IDs dos usuários, separados por vírgula (,) e sem espaços: responsible_ids=1,2,3

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

  • Valores duplicados não são permitidos.

status_idinteger

Filtrar tickets por status

priority_idsinteger[]

Filtrar tickets por prioridades.

  • Deve ser informado uma lista com os IDs das prioridades, separados por vírgula (,) e sem espaços: priority_ids=1,2,3

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

  • Valores duplicados não são permitidos.

services_catalogs_item_idsinteger[]

Filtrar tickets por item do catálogo de serviço.

  • Deve ser informado uma lista com os IDs dos itens de catálogos, separados por vírgula (,) e sem espaços: services_catalogs_item_ids=1,2,3

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

  • Valores duplicados não são permitidos.

stage_idsinteger[]

Filtrar tickets por estágios.

  • Deve ser informado uma lista com os IDs dos estágios, separados por vírgula (,) e sem espaços: stage_ids=1,2,3

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

  • Valores duplicados não são permitidos.

requestor_idsinteger[]

Filtrar tickets pelo ID de um solicitante

OBS: O solicitante precisa estar selecionado no ticket para conseguir ser encontrado por esse filtro. Se tem apenas o email preenchido, você pode usar o parâmetro :requestor_email

  • Deve ser informado uma lista com os IDs dos solicitantes, separados por vírgula (,) e sem espaços: requestor_ids=1,2,3

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

  • Valores duplicados não são permitidos.

requestor_emailstring

Filtrar tickets pelo email do solicitante

include_filled_entityboolean

Exibir os campos personalizados que estão preenchidos e relacionados nos tickets

has_jira_issueboolean

Filtrar tickets por vínculo com Jira. Por padrão será false e o filtro segue como é atualmente. Caso deseje filtrar apenas os tickets que possuem vínculo com issues do Jira, utilize true

jira_keystring

Filtrar tickets por uma chave específica do Jira (Jira Key). Ao informar uma chave, serão retornados todos os tickets vinculados a essa issue do Jira

created_by_way_ofinteger

Filtrar tickets pelo método de criação. Você deve informar o número referente a forma de criação:

  • 0 - Tiflux Web
  • 1 - Tiflux Agent
  • 2 - Chat Widget
  • 3 - Whatsapp
  • 4 - Email
  • 5 - External form
  • 6 - Tiflux Mobile
  • 7 - Tiflux API
  • 8 - Chat
  • 9 - Recurrent activity
  • 10 - Trigger
searchstring

Parâmetro de busca que permite realizar buscas detalhadas e específicas em tickets. Com ele, é possível procurar por vários campos e aplicar condições especiais para uma pesquisa avançada.

Campos de busca

Ao utilizar esse parâmetro, os tickets serão filtrados pelos seguintes campos:

  • Título do ticket
  • Nome do cliente
  • Nome da mesa
  • Número do ticket
  • Nome do responsável
  • Caracteres iniciais da descrição do ticket
date_typestring

Filtrar tickets por data de criação e data de resolução. Favor informar o parâmetro start_datetime ou end_datetime para uma busca mais precisa

start_datetimestring

Filtrar tickets cuja data de criação ou resolução seja posterior à data informada, conforme definido em date_type. Favor incluir a data com horário e timezone para uma busca mais precisa.

No formato ISO 8601: YYYY-MM-DDTHH:MM:SSZ

end_datetimestring

Filtrar tickets cuja data de criação ou resolução seja anterior à data informada, conforme definido em date_type. Favor incluir a data com horário e timezone para uma busca mais precisa.

No formato ISO 8601: YYYY-MM-DDTHH:MM:SSZ

update_start_datetimestring

Filtrar tickets pela data de atualização (que foram atualizados após essa data). Favor incluir a data com horário e timezone para uma busca mais precisa.

No formato ISO 8601: YYYY-MM-DDTHH:MM:SSZ

update_end_datetimestring

Filtrar tickets pela data de atualização (que foram atualizados antes dessa data). Favor incluir a data com horário e timezone para uma busca mais precisa.

No formato ISO 8601: YYYY-MM-DDTHH:MM:SSZ