← Pipefy

Get All Cards with Pipefy API

Pipedream makes it easy to connect APIs for Pipefy and 800+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Get All Cards with the Pipefy API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

Create a workflow to Get All Cards with the Pipefy API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Get All Cards action
    1. Connect your Pipefy account
    2. Configure graphql_query
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Details

This is a pre-built, open source component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Get All Cards on Pipefy
Description:Fetches all pipe cards based on arguments.
Version:0.1.1
Key:pipefy-get-all-cards

Code

// legacy_hash_id: a_74ijXz
import { axios } from "@pipedream/platform";

export default {
  key: "pipefy-get-all-cards",
  name: "Get All Cards",
  description: "Fetches all pipe cards based on arguments.",
  version: "0.1.1",
  type: "action",
  props: {
    pipefy: {
      type: "app",
      app: "pipefy",
    },
    graphql_query: {
      type: "object",
      description: "A graphql query as per [All Cards](https://api-docs.pipefy.com/reference/queries/#allCards) specification.",
    },
  },
  async run({ $ }) {
  /* See the API docs: https://api-docs.pipefy.com/reference/queries/#allCards

  Example query:

  {
    allCards(pipeId: 301498507) {
    pageInfo{hasNextPage} edges{node{title}}
  }
  */

    if (!this.graphql_query) {
      throw new Error("Must provide graphql_query parameter.");
    }

    return await axios($, {
      method: "post",
      url: "https://api.pipefy.com/graphql",
      headers: {
        Authorization: `Bearer ${this.pipefy.$auth.token}`,
      },
      data: this.graphql_query,
    });
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
PipefypipefyappThis component uses the Pipefy app.
graphql_queryobject

A graphql query as per All Cards specification.

Authentication

Pipefy uses API keys for authentication. When you connect your Pipefy account, Pipedream securely stores the keys so you can easily authenticate to Pipefy APIs in both code and no-code steps.

To authorize requests to the Pipefy API, you'll need to generate a Personal access token. In order to create Pipefy triggers in Pipedream, you will need to be a Pipefy administrator.

About Pipefy

Process Management, Workflow Management Software