A API pública permite integrar o PipeFácil a outros sistemas. O contrato abaixo descreve as operações, os parâmetros e as respostas disponíveis.
pf_live_… no cabeçalho Authorization.OpenAPI JSONBaixe o contrato para gerar clientes e ferramentas.Identificadores, paginação e errosMonte a integração e trate as respostas do servidor.Guias da APINegócios, cadastros, funis, calendário, conversas e automações.Recursos
Negócios
Crie, consulte e atualize negócios, etiquetas, notas, tarefas e atividades.
GETListar negócios/api/v1/dealsPOSTCriar negócio/api/v1/dealsGETListar valores de campos personalizados dos negócios/api/v1/deals/custom-field-valuesGETConsultar negócio/api/v1/deals/{seq}PATCHAtualizar negócio/api/v1/deals/{seq}POSTAdicionar etiqueta ao negócio/api/v1/deals/{seq}/tagsDELETERemover etiqueta do negócio/api/v1/deals/{seq}/tags/{tagId}POSTCriar nota do negócio/api/v1/deals/{seq}/notesPOSTEnviar anexo de nota do negócio/api/v1/deals/{seq}/notes/attachmentsPOSTCriar tarefa do negócio/api/v1/deals/{seq}/tasksGETListar atividades do negócio/api/v1/deals/{seq}/activitiesGETListar atividades do workspace/api/v1/deals/activitiesGETListar mensagens do negócio/api/v1/deals/{seq}/messagesGETObter arquivo de um campo do negócio/api/v1/deals/{seq}/properties/{slug}/filePOSTEnviar e vincular arquivo ao negócio/api/v1/deals/{seq}/properties/{slug}/fileContatos
Contatos, empresas, funis, etapas, acesso, configuração de campos, motivos de perda, etiquetas e campos personalizados podem ser gerenciados pela API. Usuários são somente leitura; gerencie membros pelo aplicativo. Qualquer chave válida pode ler funis. Alterações de funis exigem `settings.pipelines`. A leitura de contatos exige `contacts.view`; a de empresas, `companies.view`. Etiquetas e campos personalizados continuam disponíveis para leitura com qualquer chave válida. As permissões pertencem ao membro que criou a chave. Os papéis privilegiados possuem todas elas; os demais membros seguem as permissões do papel e suas exceções individuais. Empresas usam `companies.view`, `companies.edit` e `companies.delete`, independentemente das permissões de negócios.
GETListar contatos/api/v1/contactsPOSTCriar contato/api/v1/contactsGETConsultar contato/api/v1/contacts/{id}PATCHAtualizar contato/api/v1/contacts/{id}DELETEExcluir contato/api/v1/contacts/{id}POSTEnviar foto do contato/api/v1/contacts/{id}/avatarDELETERemover foto do contato/api/v1/contacts/{id}/avatarEmpresas
Contatos, empresas, funis, etapas, acesso, configuração de campos, motivos de perda, etiquetas e campos personalizados podem ser gerenciados pela API. Usuários são somente leitura; gerencie membros pelo aplicativo. Qualquer chave válida pode ler funis. Alterações de funis exigem `settings.pipelines`. A leitura de contatos exige `contacts.view`; a de empresas, `companies.view`. Etiquetas e campos personalizados continuam disponíveis para leitura com qualquer chave válida. As permissões pertencem ao membro que criou a chave. Os papéis privilegiados possuem todas elas; os demais membros seguem as permissões do papel e suas exceções individuais. Empresas usam `companies.view`, `companies.edit` e `companies.delete`, independentemente das permissões de negócios.
Funis
Contatos, empresas, funis, etapas, acesso, configuração de campos, motivos de perda, etiquetas e campos personalizados podem ser gerenciados pela API. Usuários são somente leitura; gerencie membros pelo aplicativo. Qualquer chave válida pode ler funis. Alterações de funis exigem `settings.pipelines`. A leitura de contatos exige `contacts.view`; a de empresas, `companies.view`. Etiquetas e campos personalizados continuam disponíveis para leitura com qualquer chave válida. As permissões pertencem ao membro que criou a chave. Os papéis privilegiados possuem todas elas; os demais membros seguem as permissões do papel e suas exceções individuais. Empresas usam `companies.view`, `companies.edit` e `companies.delete`, independentemente das permissões de negócios.
GETListar funis/api/v1/pipelinesPOSTCriar funil/api/v1/pipelinesGETListar funis arquivados/api/v1/pipelines/archivedPUTSubstituir motivos de perda/api/v1/pipelines/loss-reasonsGETConsultar funil/api/v1/pipelines/{seq}PATCHAtualizar funil/api/v1/pipelines/{seq}DELETEArquivar funil/api/v1/pipelines/{seq}POSTRestaurar funil/api/v1/pipelines/{seq}/unarchiveGETListar regras de acesso ao funil/api/v1/pipelines/{seq}/accessPUTSubstituir regras de acesso ao funil/api/v1/pipelines/{seq}/accessPOSTCriar etapa do funil/api/v1/pipelines/{seq}/stagesPATCHReordenar etapas do funil/api/v1/pipelines/{seq}/stages/reorderPATCHAtualizar etapa do funil/api/v1/pipelines/{seq}/stages/{stageId}DELETEExcluir etapa do funil/api/v1/pipelines/{seq}/stages/{stageId}GETListar configuração de campos do funil/api/v1/pipelines/{seq}/fieldsGETConsultar configuração de campo do funil/api/v1/pipelines/{seq}/fields/{field}PATCHAtualizar configuração de campo do funil/api/v1/pipelines/{seq}/fields/{field}Etiquetas
Contatos, empresas, funis, etapas, acesso, configuração de campos, motivos de perda, etiquetas e campos personalizados podem ser gerenciados pela API. Usuários são somente leitura; gerencie membros pelo aplicativo. Qualquer chave válida pode ler funis. Alterações de funis exigem `settings.pipelines`. A leitura de contatos exige `contacts.view`; a de empresas, `companies.view`. Etiquetas e campos personalizados continuam disponíveis para leitura com qualquer chave válida. As permissões pertencem ao membro que criou a chave. Os papéis privilegiados possuem todas elas; os demais membros seguem as permissões do papel e suas exceções individuais. Empresas usam `companies.view`, `companies.edit` e `companies.delete`, independentemente das permissões de negócios.
Campos personalizados
Contatos, empresas, funis, etapas, acesso, configuração de campos, motivos de perda, etiquetas e campos personalizados podem ser gerenciados pela API. Usuários são somente leitura; gerencie membros pelo aplicativo. Qualquer chave válida pode ler funis. Alterações de funis exigem `settings.pipelines`. A leitura de contatos exige `contacts.view`; a de empresas, `companies.view`. Etiquetas e campos personalizados continuam disponíveis para leitura com qualquer chave válida. As permissões pertencem ao membro que criou a chave. Os papéis privilegiados possuem todas elas; os demais membros seguem as permissões do papel e suas exceções individuais. Empresas usam `companies.view`, `companies.edit` e `companies.delete`, independentemente das permissões de negócios.
GETListar campos personalizados/api/v1/custom-fieldsPOSTCriar campo personalizado/api/v1/custom-fieldsPOSTEnviar arquivo de campo personalizado/api/v1/custom-fields/uploadGETObter URL de arquivo de campo personalizado/api/v1/custom-fields/fileGETConsultar campo personalizado/api/v1/custom-fields/{id}PATCHAtualizar campo personalizado/api/v1/custom-fields/{id}DELETEExcluir campo personalizado/api/v1/custom-fields/{id}Membros
Contatos, empresas, funis, etapas, acesso, configuração de campos, motivos de perda, etiquetas e campos personalizados podem ser gerenciados pela API. Usuários são somente leitura; gerencie membros pelo aplicativo. Qualquer chave válida pode ler funis. Alterações de funis exigem `settings.pipelines`. A leitura de contatos exige `contacts.view`; a de empresas, `companies.view`. Etiquetas e campos personalizados continuam disponíveis para leitura com qualquer chave válida. As permissões pertencem ao membro que criou a chave. Os papéis privilegiados possuem todas elas; os demais membros seguem as permissões do papel e suas exceções individuais. Empresas usam `companies.view`, `companies.edit` e `companies.delete`, independentemente das permissões de negócios.
Calendário
Calendário unificado do workspace: reuniões, tarefas, etapas de cadência e eventos do Google Calendar do membro. Exige o recurso `CALENDAR` no workspace.
Conversas
Envie mensagens e consulte conversas e seus históricos. Exige `ADVANCED_API`, além de `API_ACCESS`, necessário para qualquer chave. Sem o recurso, as rotas deste grupo respondem `403 FEATURE_DISABLED`.
Cadências
Consulte cadências, seus negócios matriculados e o ciclo de matrícula de cada negócio. Exige **`CADENCE` e `ADVANCED_API`** no workspace. O acesso externo é contratado separadamente e vem desligado por padrão. A ausência de qualquer recurso resulta em `403 FEATURE_DISABLED`. A rota `tasks/{taskId}/execute` envia de fato uma mensagem por WhatsApp, um e-mail ou uma chamada externa e pode gerar cobrança no workspace. Envie a `idempotencyKey` obrigatória: repetir a mesma chave retorna `duplicated: true`, sem novo envio. As outras rotas alteram somente o estado da cadência.
GETListar cadências/api/v1/cadencesGETListar matrículas da cadência/api/v1/cadences/{cadenceId}/enrollmentsGETConsultar cadência do negócio/api/v1/deals/{seq}/cadencePOSTMatricular negócio em cadência/api/v1/deals/{seq}/cadence/enrollPOSTRemover negócio da cadência/api/v1/deals/{seq}/cadence/unenrollPOSTPausar cadência do negócio/api/v1/deals/{seq}/cadence/pausePOSTRetomar cadência do negócio/api/v1/deals/{seq}/cadence/resumePOSTIniciar cadência do negócio/api/v1/deals/{seq}/cadence/startPOSTExecutar tarefa de cadência/api/v1/deals/{seq}/cadence/tasks/{taskId}/executePOSTPular tarefa de cadência/api/v1/deals/{seq}/cadence/tasks/{taskId}/skipPOSTConcluir tarefa de cadência manualmente/api/v1/deals/{seq}/cadence/tasks/{taskId}/complete-manualAutomações
Gerencie fluxos de automação e consulte o histórico de execução. Exige `ADVANCED_API` e `API_ACCESS`; sem o recurso, as rotas respondem `403 FEATURE_DISABLED`. O acesso por API é a operação externa das automações disponíveis no aplicativo. A leitura exige `automations.view`; alterações exigem `automations.edit`. Esta última permissão não pertence ao conjunto padrão de nenhum papel comum: conceda uma exceção explícita ao membro que precisa editar fluxos. Um fluxo ativo pode enviar mensagens aos clientes automaticamente. Os papéis privilegiados `owner`, `admin`, `partner` e `support` possuem todas as permissões na API. Assim, `partner` e `support` podem alterar automações por esta API, embora as rotas de escrita do aplicativo sejam restritas a `owner` e `admin`. Nenhuma rota deste grupo inicia a execução de uma automação. `POST /{id}/test` não envia mensagens nem entrega o webhook: retorna o corpo assinado que a primeira ação de webhook enviaria. Exige `automations.edit`, pois usa o segredo real para calcular a assinatura. As respostas de leitura removem segredos de webhook, inclusive nos logs e nas cópias da definição de uma execução. Quando uma criação ou atualização gera um segredo, a resposta o mostra uma única vez. Limitação: não há rota pública para listar `outboundChannelId` nem os identificadores `channelId`, `mediaAssetId` e `scriptId` das ações `send_whatsapp`. Obtenha esses identificadores fora desta referência. Funis, etapas, etiquetas, campos e usuários podem ser consultados em `/api/v1/pipelines`, `/tags`, `/custom-fields` e `/users`.
GETListar automações/api/v1/automationsPOSTCriar automação/api/v1/automationsGETListar catálogo de gatilhos/api/v1/automations/triggersGETConsultar automação/api/v1/automations/{id}PUTSubstituir automação/api/v1/automations/{id}DELETEExcluir automação/api/v1/automations/{id}PATCHAtivar ou desativar automação/api/v1/automations/{id}/enabledPOSTPré-visualizar entrega de webhook/api/v1/automations/{id}/testGETListar logs da automação/api/v1/automations/{id}/logsGETListar entregas de webhook/api/v1/automations/{id}/deliveriesGETListar execuções da automação/api/v1/automations/{id}/runsGETConsultar execução da automação/api/v1/automations/{id}/runs/{runId}Servidor
https://pipefacil-server.matchsales.com.br