Listar tickets no Freshdesk, por uma API
Lista tickets, os mais recentes primeiro por padrão. Sem updated_since voltam só os tickets criados nos últimos 30 dias, e spam ou excluídos só vêm com filtro.
- Identificador
- freshdesk_list_tickets
A chamada
POST https://connect.reportei.com/api/tools/freshdesk_list_tickets/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"filter": "new_and_my_open"
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| filter | string | Não | Predefined view: new and open tickets of the agent, tickets the agent watches, spam or deleted tickets.Valores: new_and_my_open, watching, spam, deleted |
| requester_id | integer | Não | Only the tickets of this requester: the id of a contact from List contacts, or the requester_id of a ticket. |
| string | Não | Only the tickets of the requester with this email address. | |
| unique_external_id | string | Não | Only the tickets of the requester with this external id, the id of the requester in your own system. |
| company_id | integer | Não | Only the tickets of this company, from Search companies. |
| updated_since | string | Não | Only tickets updated at or after this UTC time, for example 2026-10-01T00:00:00Z. Use it to reach tickets older than 30 days. |
| order_by | string | Não | Sort field. The default is created_at.Valores: created_at, due_by, updated_at, status |
| order_type | string | Não | Sort order. The default is desc.Valores: asc, desc |
| include | string | Não | Comma-separated extras for each ticket: stats (closed, resolved and first response times), requester (email, id, mobile, name and phone) and description. Each one costs 2 more API credits per call. |
| page | integer | Não | Page number, starting at 1. |
| per_page | integer | Não | Tickets per page, up to 100. The default is 30. |
Conexões possíveis
O seu cliente conecta a conta do Freshdesk uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
Usuário e senha
O cliente informa as credenciais do app numa tela do Connect, ou o seu sistema as envia por POST /api/customer-toolkits, sem tela.
Na conexão, o cliente informa também {domain}: o endereço da conta dele na API do app.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/freshdesk_list_tickets. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Freshdesk
- Buscar ticketsGETBusca tickets com uma query de filtro, por exemplo por status, prioridade, agente, grupo, tag ou campo personalizado. Devolve total e results, 30 tickets por página.
- Obter ticketGETDevolve um ticket com status, priority, requester_id, responder_id, group_id, tags, custom_fields e description.
- Criar ticketPOSTCria um ticket. Identifique o solicitante com requester_id, email, phone ou unique_external_id; um email ou phone ainda não existente no Freshdesk cria o contato.
- Atualizar ticketPUTAtualiza um ticket: envie só os campos a mudar, e tags como a lista completa que o ticket deve manter. Status 4 resolve e 5 fecha o ticket.
- Listar conversas do ticketGETLista as respostas e notas de um ticket, com body (HTML), body_text, private, incoming, user_id e source (0 resposta, 2 nota). As páginas são numeradas a partir de 1.
- Criar resposta no ticketPOSTResponde ao solicitante de um ticket. O Freshdesk envia a resposta por e-mail ao solicitante, então ela fica visível ao cliente.
- Criar nota no ticketPOSTAdiciona uma nota a um ticket. As notas são privadas por padrão, visíveis só aos agentes; com private false o solicitante também a vê.
- Listar campos de ticketGETLista os campos de ticket do helpdesk com suas opções: ids de agentes no campo de agente, ids de grupos no campo de grupo, ids de produtos e valores de status.
Toolkits da mesma categoria
Ver os 100 toolkitsVeja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
