Listar envios no Jotform, por uma API
Lista os envios de todos os formulários da conta, cada um com id, form_id, created_at, status, new e as respostas indexadas pelo id da pergunta, cada uma com o rótulo, o tipo e a resposta. Pagine com offset e limit até vir menos envios que limit.
- Identificador
- jotform_list_submissions
A chamada
POST https://connect.reportei.com/api/tools/jotform_list_submissions/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"offset": 1
}
}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 |
|---|---|---|---|
| offset | integer | Não | Items to skip, 0 by default. |
| limit | integer | Não | Submissions per call, 20 by default and up to 1000. |
| filter | string | Não | Filter as a JSON object in text, on id, form_id, IP, created_at, status, new, flag or updated_at; a key can end in :gt, :lt or :ne. formIDs takes a list of form ids from List forms and fullText searches the answers, like {"formIDs":["30693660548966"]} or {"fullText":"John Brown"}. |
| orderby | string | Não | Field the submissions are sorted by.Valores: id, form_id, IP, created_at, status, new, flag, updated_at |
Conexões possíveis
O seu cliente conecta a conta do Jotform uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
Chave de API
O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.
Na conexão, o cliente informa também {region}: 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/jotform_list_submissions. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Jotform
- Listar formuláriosGETLista os formulários da conta com id, title, status, url, datas e as contagens de envios (count) e de não lidos (new). Pagine com offset e limit até vir menos formulários que limit.
- Obter formulárioGETRetorna os detalhes básicos de um formulário: title, status (ENABLED, DISABLED ou DELETED), url, datas, último envio, total de envios (count) e não lidos (new).
- Listar perguntas do formulárioGETLista as perguntas de um formulário indexadas pelo id da pergunta (qid), com type, label (text), name, order e configurações como required. Os envios indexam suas respostas pelo mesmo qid.
- Listar envios do formulárioGETLista os envios de um formulário, cada um com id, created_at, status (ACTIVE ou OVERQUOTA), new e as respostas indexadas pelo id da pergunta, cada uma com o rótulo, o tipo e a resposta. Pagine com offset e limit até vir menos envios que limit.
- Obter envioGETRetorna um envio com form_id, created_at, status, new e as respostas indexadas pelo id da pergunta, cada uma com o rótulo, o tipo e a resposta.
- Listar relatórios do formulárioGETLista os relatórios de um formulário com id, title, o tipo em list_type (excel, csv, grid, table, calendar, rss ou visual), os campos que exibem e a url onde o relatório abre.
- Obter relatórioGETRetorna um relatório com form_id, title, list_type, os campos que exibe, status, url e se é protegido por senha.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
