API Use Case Examples

This section contains practical examples of how to use the Pipefy API for common use cases. These examples are organized into modules to help you find the specific functionality you're looking for.

Table of Contents

1. AI

• Agents usage details query

2. Automation

• Automation
• Automation actions
• Automation events
• Automations usage details query
• 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

3. Card and Field

• Add attachments to a card or field
• Create a card with required fields
• Create fields in a phase
• Move card to a different phase

4. Email and Communication

• Create and send an email through a card
• List emails from a card

5. Field

• Search for field dependencies

6. Form and Configuration

• Configure a start form on existing pipe
• Create a pipe with start form configured

7. Organization

• Organization usage stats
• Retrieve organization settings
• Track active users in your organization

8. Phase

• Create fields in a phase
• Move card to a different phase
• Update phase settings

9. Pipe

• Create a pipe with start form configured

10. Query Tips

• Get resource IDs
• Pagination basics
• Run multiple queries or mutations in a single request

11. Report

• Get reports

12. Tag

• Add tags to resource
• Retrieve Tag Categories of an Organization
• Tags by category
• Tags by category on resource
• Update tag category

13. Ticket

• See tickets

14. Usage Stats

• Agents usage details query
• Automation usage details query
• Organization usage stats

15. User

• Set user favorite pipes
• Set user roles via GraphQL mutation
• See users suggestions

About These Examples

These use cases demonstrate common integration scenarios and best practices when working with the Pipefy API. Each example includes:

• A detailed description of the use case
• Required API permissions
• Example GraphQL queries or mutations
• Sample responses
• Implementation notes and considerations

Whether you're building a new integration or looking to enhance existing functionality, these examples provide practical guidance for working with the Pipefy API.