Pipefy icon

Pipefy

Interact with Pipefy GraphQL API

Actions17

Pipe → Get

AI-generated

Summary

Retrieve a Pipefy pipe by its ID. The result includes core pipe details and organization ID and name; optional flags add labels, members, phases, or webhooks.

Inputs

  • Authentication (required) — Choose Service Account or Personal Access Token credentials; Service Account is the default.
  • Pipe ID (required) — ID of the pipe to retrieve.
  • Include Labels? — Defaults to false. When enabled, includes each label's color, ID, and name.
  • Include Members? — Defaults to false. When enabled, includes pipe member details and their user information.
  • Include Phases? — Defaults to false. When enabled, includes phase metadata such as ID, name, status, and card counts.
  • Include Webhooks? — Defaults to false. When enabled, includes webhook email, filters, headers, ID, name, and URL.

Output shape

A single item containing the pipe's fields in its json object.

Core fields include pipe metadata and its organization ID and name. Optional nested arrays are included only when their corresponding flags are enabled.

Links

Discussion