canonical: https://jentic.com/apis/pipefy.com/pipefy # Pipefy API Jentic publishes the only available OpenAPI specification for Pipefy API, keeping it validated and agent-ready. Pipefy API provides workflow and process automation through a GraphQL endpoint. The API enables managing pipes (workflow boards), cards (work items), phases (stages), fields, and automations, allowing teams to build, customize, and operate business processes including approvals, onboarding, procurement, and service requests. ## For AI agents Manage workflow pipes, cards, phases, and automations through a GraphQL endpoint for business process automation including approvals, onboarding, and service requests. ## Scope Does not handle project portfolio management, time tracking, or resource planning - use for structured workflow and process automation only. ## Capabilities - Create and move cards through workflow phases for process automation - Query pipes and their phases to understand workflow structure - Manage card fields and attachments for work item data - Configure workflow automations and conditional triggers - Track process metrics and card movement through stages - Build custom business processes with configurable phases and fields ## Use cases ### Business Process Automation Automate approval workflows, procurement requests, and service delivery through Pipefy pipes. The GraphQL API creates cards in the appropriate pipe, moves them through phases as conditions are met, and triggers notifications at each stage. Teams replace email-based approvals with structured, trackable processes. Example prompt: Create a new card in pipe ID 12345 with title 'Purchase Request' and fields for amount, vendor, and justification ### Employee Onboarding Workflow Manage new hire onboarding through a structured Pipefy pipe with phases for IT setup, HR paperwork, team introductions, and training. The API creates onboarding cards automatically when new employees are added, tracks completion of each phase, and notifies responsible parties at each stage. Example prompt: Create an onboarding card for new employee 'John Smith' with start date and department fields, then query the phase structure of the onboarding pipe ### Service Request Management Process service requests through configurable pipes with intake forms, approval phases, and completion tracking. Pipefy handles the request lifecycle from submission through fulfillment, with fields capturing request details and phases enforcing the correct processing order. Example prompt: Query all cards in the 'Pending Approval' phase of the service request pipe and list their titles and creation dates ### AI Agent Process Orchestration AI agents use the Pipefy API through Jentic to create cards, query workflow status, and advance processes without manual intervention. Agents search for workflow operations by intent, load the GraphQL schema, and execute mutations with Jentic handling Bearer token authentication. Example prompt: Search Jentic for 'create workflow card', load the Pipefy GraphQL endpoint schema, and create a card with custom field values in the target pipe ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | `/graphql` | Execute GraphQL queries and mutations for all pipe operations | ## Key resources - **Pipes** — Workflow boards with configurable phases, fields, and automations - **Cards** — Work items that move through pipe phases - **Phases** — Stages in a workflow that cards progress through - **Fields** — Custom data fields attached to cards - **Automations** — Conditional triggers and actions within pipes ## Why Jentic - **Setup:** Wiring Pipefy by hand means managing its bearer token, hand-writing GraphQL queries and mutations against the single /graphql endpoint, and handling retries yourself. Through Jentic you install once, import Pipefy from the API Directory, store the token once, and your agent calls it. - **Permission scoping:** Pipefy exposes one /graphql endpoint, so you limit the agent to the specific operations it needs, such as creating a card, rather than the whole schema. Because you choose the allowed operations, mutations you do not grant stay out of reach. - **Credential handling:** Your Pipefy bearer token is stored once, encrypted, by your own Jentic One instance and injected as an Authorization header at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'create a workflow card', and Jentic returns the matching Pipefy operation with its input schema so the agent constructs the right mutation without browsing the reference docs. ## Related APIs - **Trello API** — Trello provides simpler kanban boards without Pipefy's process automation and conditional logic - **Asana API** — Asana offers project and task management with portfolio views and workload tracking - **n8n API** — n8n provides workflow automation between services that can trigger Pipefy card creation and movement ## FAQ ### Why is there no official OpenAPI spec for Pipefy API? Pipefy uses a GraphQL API rather than REST, so there is no native OpenAPI specification. Jentic generates and maintains this OpenAPI wrapper so that AI agents and developers can discover Pipefy operations via structured tooling. Get started with Jentic One, the self-hosted execution layer. ### What authentication does the Pipefy API use? The Pipefy API uses Bearer token authentication. You generate a personal access token or OAuth token in the Pipefy app and pass it in the Authorization header. Through Jentic, this token is stored encrypted in your Jentic One instance. ### Can I create and move cards through workflow phases with the Pipefy API? Yes. Use the createCard GraphQL mutation to add work items to a pipe, and moveCardToPhase to advance them through stages. You can also update card fields and add comments at each phase transition. ### Is the Pipefy API REST or GraphQL? The Pipefy API is GraphQL, accessed through a single POST /graphql endpoint. All operations (queries and mutations for pipes, cards, phases, fields) go through this endpoint with different GraphQL payloads. ### How do I create a workflow card through the Pipefy API using Jentic? Search Jentic for 'create workflow card', load the /graphql operation schema, and execute a createCard mutation with pipe ID and field values. Jentic handles Bearer token injection and GraphQL request formatting. ### Can I query cards by phase or status in Pipefy? Yes. Use the allCards query with phase_id filter to retrieve cards in a specific phase. You can also filter by assignee, due date, and custom field values to find cards matching specific criteria across your workflow. ### Can I limit what my agent is allowed to do with the Pipefy API? Yes. Pipefy exposes a single /graphql endpoint, and because you run Jentic One yourself, your own rules decide which operations the agent may call, so you can allow just the ones it needs, such as createCard, and leave the rest of the schema out of reach. Mutations you do not grant, like moveCardToPhase or field updates, cannot be executed by the agent. The Pipefy bearer token stays with your Jentic One instance and is injected only for the operations you permit.