Pipefy icon

Pipefy

Interact with Pipefy GraphQL API

Overview

This node interacts with the Pipefy platform to retrieve detailed information about a specific card by its ID. It is useful when you want to fetch comprehensive data about a card, including optional related entities such as assignees, attachments, comments, fields, labels, inbox emails, and phases history. Typical use cases include automating workflows that require up-to-date card details for reporting, notifications, or further processing in an automation pipeline.

For example, you might use this node to:

  • Get all details of a project task card to update a dashboard.
  • Retrieve comments and attachments on a support ticket card for customer service automation.
  • Fetch the phase history of a card to analyze process flow and bottlenecks.

Properties

Name Meaning
Authentication Choose the authentication method: "Service Account" or "Personal Access Token".
Card ID The unique identifier of the card to retrieve. Found in the card's URL (e.g., https://app.pipefy.com/open-cards/[ID]). Required field.
Include Assignees? Whether to include the list of users assigned to the card. Boolean option: true or false.
Include Attachments? Whether to include the attachments associated with the card. Boolean option: true or false.
Include Comments? Whether to include comments made on the card. Boolean option: true or false.
Include Fields? Whether to include the custom fields and their values on the card. Boolean option: true or false.
Include Labels? Whether to include labels/tags attached to the card. Boolean option: true or false.
Include Inbox Emails? Whether to include emails received in the card’s inbox. Boolean option: true or false.
Include Phases History? Whether to include the history of phases the card has passed through. Boolean option: true or false.

Output

The node outputs a JSON array where each item corresponds to the retrieved card data enriched with the requested optional details. The structure includes:

  • Core card properties such as ID, title, description, creation date, etc.
  • Conditionally included arrays or objects for assignees, attachments, comments, fields, labels, inbox emails, and phases history depending on the selected options.

If any binary data (such as file attachments) is returned, it would be represented in the binary output format, but this node primarily returns structured JSON data describing the card and its related entities.

Dependencies

  • Requires access to the Pipefy GraphQL API.
  • Requires either a Service Account credential or a Personal Access Token credential configured in n8n for authentication.
  • Network connectivity to Pipefy’s API endpoint.

Troubleshooting

  • Invalid Card ID: If the card ID is incorrect or does not exist, the node will likely return an error indicating the card was not found. Verify the card ID from the Pipefy UI URL.
  • Authentication Errors: Using invalid or expired credentials will cause authentication failures. Ensure the API key or token is valid and has sufficient permissions.
  • API Rate Limits: Frequent requests may hit Pipefy API rate limits causing temporary failures. Implement retry logic or reduce request frequency.
  • Missing Optional Data: If optional data like comments or attachments are enabled but not present on the card, those fields may be empty or omitted.
  • Network Issues: Connectivity problems can cause timeouts or failed requests. Check network settings and Pipefy service status.

Links and References

Discussion