> ## Documentation Index > Fetch the complete documentation index at: https://docs.ipbox.com.br/llms.txt > Use this file to discover all available pages before exploring further. # getFP1 > ## Retorna o FP1 - Relatório de Fichas Preenchidas - Ao consultar por fichaId, todas as fichas especificadas devem pertencer ao mesmo formulário. Caso contrário, um erro é retornado. - Os parâmetros user/senha só são obrigatórios quando o sistema possui ATIVAR_PERMISSAO_POR_TIME ou ATIVAR_PERMISSAO_POR_OPERACAO habilitados. Quando ativos, os resultados são filtrados conforme as permissões de time do usuário. ### Resposta — Formato JSON (formato=json) HTTP 200 Content-Type: application/vnd.api+json `{ "data": [ { "ficha": "1234", "data": "15/01/2025 14:30:00", "status": "Finalizado", "agente": "joao.silva", "time": "Equipe Vendas", "codigo": "C001", "cpf": "12345678900", "nome": "Maria da Silva", "ddd_cel": "11", "tel_cel": "987654321", "ddd_com": "", "tel_com": "", "ddd_res": "11", "tel_res": "12345678", "lote": "Campanha Janeiro", "pontos": "85", "campo_personalizado_p": "valor", "pergunta_1_5_f": "Sim", "observacoes_5_f": "Cliente satisfeito" } ] }` As chaves JSON são normalizadas para snake_case ASCII (acentos transliterados, caracteres especiais substituídos por _). Sufixos nos cabeçalhos: \[P\] = campo customizado do prospect, \[F\] = campo do formulário. ### Resposta — Formato CSV (formato=csv) HTTP 200 Content-Type: application/vnd.api+json Conteúdo CSV delimitado por ponto e vírgula. A primeira linha é o cabeçalho. `ficha;data;status;agente;time;codigo;cpf;nome;ddd_cel;tel_cel;ddd_com;tel_com;ddd_res;tel_res;lote;pontos;"Pergunta 1 [5] [F]";"Observacoes [5] [F]" 1234;"15/01/2025 14:30:00";Finalizado;joao.silva;"Equipe Vendas";C001;12345678900;"Maria da Silva";11;987654321;;;11;12345678;"Campanha Janeiro";85;Sim;"Cliente satisfeito"` ## OpenAPI ````yaml /openapi.yaml post /ipbox/api/getFP1 openapi: 3.0.0 info: title: IPBoX Api Documentation v1.1 description: >- Nesse documento são descritos os comandos presentes na API Rest do IPBoX. Os comandos são executados com chamadas POST e com respostas em formato JSON. version: 1.0.0 servers: - url: https://{baseUrl} description: Dominio (e porta, se houver) do servidor IPBoX do cliente variables: baseUrl: default: cliente.ipboxcloud.com.br:9052 description: >- Substitua pelo dominio real do seu servidor IPBoX. A maioria dos servidores usa uma porta especifica - inclua-a junto ao dominio (ex.: cliente.ipboxcloud.com.br:9052) security: - ApiToken: [] tags: - name: Agente - name: Ligações - name: Prospects - name: Agendamentos - name: Listas - name: Filas - name: Lotes - name: Relatórios - name: Outros - name: Times - name: Blacklist - name: Áudios - name: URAs paths: /ipbox/api/getFP1: post: tags: - Relatórios summary: getFP1 description: >- ## Retorna o FP1 - Relatório de Fichas Preenchidas - Ao consultar por fichaId, todas as fichas especificadas devem pertencer ao mesmo formulário. Caso contrário, um erro é retornado. - Os parâmetros user/senha só são obrigatórios quando o sistema possui ATIVAR_PERMISSAO_POR_TIME ou ATIVAR_PERMISSAO_POR_OPERACAO habilitados. Quando ativos, os resultados são filtrados conforme as permissões de time do usuário. ### Resposta — Formato JSON (formato=json) HTTP 200 Content-Type: application/vnd.api+json `{ "data": [ { "ficha": "1234", "data": "15/01/2025 14:30:00", "status": "Finalizado", "agente": "joao.silva", "time": "Equipe Vendas", "codigo": "C001", "cpf": "12345678900", "nome": "Maria da Silva", "ddd_cel": "11", "tel_cel": "987654321", "ddd_com": "", "tel_com": "", "ddd_res": "11", "tel_res": "12345678", "lote": "Campanha Janeiro", "pontos": "85", "campo_personalizado_p": "valor", "pergunta_1_5_f": "Sim", "observacoes_5_f": "Cliente satisfeito" } ] }` As chaves JSON são normalizadas para snake_case ASCII (acentos transliterados, caracteres especiais substituídos por _). Sufixos nos cabeçalhos: \[P\] = campo customizado do prospect, \[F\] = campo do formulário. ### Resposta — Formato CSV (formato=csv) HTTP 200 Content-Type: application/vnd.api+json Conteúdo CSV delimitado por ponto e vírgula. A primeira linha é o cabeçalho. `ficha;data;status;agente;time;codigo;cpf;nome;ddd_cel;tel_cel;ddd_com;tel_com;ddd_res;tel_res;lote;pontos;"Pergunta 1 [5] [F]";"Observacoes [5] [F]" 1234;"15/01/2025 14:30:00";Finalizado;joao.silva;"Equipe Vendas";C001;12345678900;"Maria da Silva";11;987654321;;;11;12345678;"Campanha Janeiro";85;Sim;"Cliente satisfeito"` parameters: - name: Authorization in: header schema: type: string example: '{{token}}' - name: Content-Type in: header schema: type: string example: application/x-www-form-urlencoded requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: form: type: string description: >- Identificador do formulário. Aceita ID numérico ou nome (descrição) do formulário. example: form de: type: string description: >- Data/hora inicial no formato YYYYMMDDhhmmss. Exemplo: 20250101000000 example: de ate: type: string description: >- Data/hora final no formato YYYYMMDDhhmmss. Exemplo: 20250131235959 example: ate fichaId: type: string description: >- IDs de fichas separados por vírgula. Suporta faixas com - (ex: 100,101,200-210). Quando informado, form, de e ate não são obrigatórios. Todas as fichas devem pertencer ao mesmo formulário. example: fichaId lote: type: string description: Filtro de lote. Aceita ID numérico ou nome do lote. example: lote agente: type: string description: Filtro de agente. Aceita ID numérico ou login. example: agente time: type: string description: Filtro de time. Aceita ID numérico ou nome do time. example: time status: type: string description: Filtro de status da ficha. example: status operacao: type: string description: Filtro de operação. Aceita ID numérico ou nome da operação. example: operacao fila: type: string description: Filtro de fila. Aceita ID numérico ou nome da fila. example: fila prospect: type: string description: Filtro por nome do prospect example: prospect formato: type: string description: 'Formato de saída: json (padrão) ou csv.' example: formato user: type: string description: >- Login do usuário. Obrigatório quando a permissão por time ou operação está habilitada (ATIVAR_PERMISSAO_POR_TIME ou ATIVAR_PERMISSAO_POR_OPERACAO). example: user senha: type: string description: >- Senha do usuário. Obrigatório junto com user quando as verificações de permissão estão habilitadas. example: senha required: - form - de - ate responses: '200': description: Successful response content: application/json: {} components: securitySchemes: ApiToken: type: apiKey in: header name: Authorization description: >- Token gerado em IPBoX > API > Token. Aceita o token puro, ou com prefixo `Bearer ` / `Basic `. ````