Jump to Content
Pipefy Developers
HomeDocumentationAPI ReferenceGraphQLChangelog
Support from Community ↗︎Back to Pipefy ↗︎Pipefy Developers
API Reference
Support from Community ↗︎Back to Pipefy ↗︎
HomeDocumentationAPI ReferenceGraphQLChangelog

Introduction for non-developers

  • Why GraphQL?
  • Why Pipefy’s GraphQL API?

Getting Started

  • Pipefy API Request Handling
  • Creating calls with GraphQL
    • GraphQL Structure
    • Limits and Best Practices
    • Exploring the Playground
    • Mastering the Documentation: Your Guide to Queries and Mutations
  • Pipefy GraphQL Collection
  • Authentication
    • Service Accounts
    • Personal Access Token

Objects Overview

  • Organizations
  • Users
  • Pipes
    • Cards
    • Fields
    • Phases
    • Pipe Reports
  • Database Tables
    • Table Records

Use case examples

  • Summary
  • AI
    • AI Agents Usage
    • Enable or disable AI features
  • Automation
    • Get an Automation by ID
    • Automation Actions
    • Automation Events
    • Automations Usage
    • Retrieve Automations
    • Retrieve Automation Logs
    • Retrieve Automation Logs by Repo
    • Get Automation Initial Values
    • Get Automation Event Attributes
    • List Automated Formula Operations
    • Export Automation Jobs
    • Simulate Automation Execution
    • Create Automation
    • Delete Automation
    • Update Automation
  • Card and Field
    • Add attachments to a card or field
    • Create a card with the required fields fulfilled
    • Create fields in a phase
    • Move Card to a Different Phase
    • Create connected cards using throughConnectors
  • Email and Communication
    • Create and send an email through a card
    • List emails from a card
  • Form and Configuration
    • Configure a Start Form on existing pipe
    • Create a pipe with Start Form configured
    • Filter Authorized Forms to Me by Organization
  • Organization
    • Organization Usage Stats
    • Retrieve Organization Settings
    • Track active users in your organization
    • Fetch Organization Active Subscription
  • Phase
    • Create fields in a phase
    • Move Card to a Different Phase
    • Update Phase Settings
  • Pipe
    • Create a pipe with Start Form configured
  • Query Tips
    • Get Resource IDs
    • Pagination Basics
    • Run Multiple Queries or Mutations in a Single Request
  • Report
    • Get Reports
    • Get Organization Report
    • Get Organization Reports
    • Create Organization Report
    • Update Organization Report
    • Delete Organization Report
    • Export Organization Report
  • Tag
    • Add Tags to a Resource
    • Retrieve Tag Categories of an Organization
    • Retrieve Tags by Category of an Organization
    • Retrieve Tags by Category on a Resource
    • Update Tag Category
    • Create Tags in Bulk
    • Update tags Visibility by Category
    • Update Tag
    • Create Tag
  • Usage Stats
    • AI Agents Usage
    • Automations Usage
    • Organization Usage Stats
    • AI Credits Usage Stats
  • User
    • Set User's Favorite Pipes
    • Set User Roles via GraphQL Mutation
    • Get users suggestions by Organization UUID
  • Field
    • Get field dependencies by field UUID
  • Ticket
    • See a Ticket by ID
  • SMTP Configuration
    • Create SMTP Configuration
  • SMTP Custom Email
    • Create SMTP Custom Email with SMTP Configuration
  • Roles

Troubleshooting

  • How to handle errors
  • Common Errors
    • Receiving Unauthorized
    • Receiving invalid_role
    • Receiving resource_not_found
    • Receiving missingRequiredInputObjectAttribute
    • Receiving usage_limit_exceeded
    • Receiving Card could not be moved to phase
    • Receiving invalid_input
  • Status codes and Error Handling
  • Still Stuck?

Webhooks Overview

  • Organization Webhooks
  • Pipe & Table Webhooks

API Features

  • Importing
    • Cards Importer
    • Records Importer

Requesting outside the playground

  • The GraphQL Endpoint

Roles

Custom Role Operations

  • Create Custom Role - Create a new custom role for an organization
  • Delete Custom Role - Delete an existing custom role from an organization
  • Table of Contents
    • Custom Role Operations
  • How Pipefy Works
  • Features
  • Security
  • What's New

DEVELOPERS

  • Documentation
  • API Reference
  • API Docs
  • Changelog

HELP & SUPPORT

  • Help Center
  • Community
  • User Guide
  • Webinars