Actions17
- Attachment Actions
- Card Actions
- Pipe Actions
- User Actions
- Webhook Actions
Overview
This node interacts with the Pipefy platform via its GraphQL API to retrieve detailed information about a specific card. It is useful when you want to fetch comprehensive data about a card in your Pipefy workflow, including optional related entities such as assignees, attachments, comments, fields, labels, inbox emails, and phase history.
Typical use cases include:
- Automating reporting or auditing by extracting card details.
- Integrating Pipefy card data into other systems or dashboards.
- Triggering workflows based on card content or status changes.
- Enriching card data with related information like comments or attachments for further processing.
For example, you might use this node to get a card’s full details along with its comments and attachments to send a summary email or update a CRM system.
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. |
| Include Assignees? | Whether to include the list of users assigned to the card. Boolean (true/false). |
| Include Attachments? | Whether to include the attachments associated with the card. Boolean (true/false). |
| Include Comments? | Whether to include comments made on the card. Boolean (true/false). |
| Include Fields? | Whether to include the custom fields and their values on the card. Boolean (true/false). |
| Include Labels? | Whether to include labels/tags assigned to the card. Boolean (true/false). |
| Include Inbox Emails? | Whether to include emails received in the card’s inbox. Boolean (true/false). |
| Include Phases History? | Whether to include the history of phases the card has gone through. Boolean (true/false). |
Output
The node outputs an array of JSON objects representing the requested card(s) with the selected details included. The structure includes:
- Basic card information (ID, title, description, etc.).
- Optionally, arrays or objects for:
- Assignees: user details assigned to the card.
- Attachments: metadata about files attached to the card.
- Comments: text and metadata of comments on the card.
- Fields: key-value pairs of custom fields on the card.
- Labels: tags or labels applied to the card.
- Inbox Emails: emails linked to the card’s inbox.
- Phases History: records of the card’s movement through different phases.
If binary data (such as file attachments) is returned, it would be represented accordingly, but this node primarily returns metadata about attachments rather than raw binary content.
Dependencies
- Requires access to the Pipefy GraphQL API.
- Requires either a service account credential or a personal access token for authentication.
- No additional external dependencies beyond standard n8n environment and credentials setup.
Troubleshooting
- Invalid Card ID: If the card ID is incorrect or does not exist, the node will fail to retrieve data. Verify the card ID from the Pipefy UI URL.
- Authentication Errors: Ensure that the provided API credentials are valid and have sufficient permissions to access the card data.
- API Rate Limits: Excessive requests may hit Pipefy API rate limits; consider adding delays or handling retries.
- Missing Optional Data: If optional flags (e.g., Include Comments) are set to false, those parts of the response will be absent.
- Network Issues: Connectivity problems can cause request failures; verify network access to Pipefy API endpoints.