Query all pipes accessible by the authenticated user in an organization that have the integrations app enabled.
Before You Begin
🔗 Use the GraphQL Playground to execute the queries in this guide.
➡️ New to GraphQL? Learn how to navigate the Playground with our Playground Basics Guide.
Prerequisites
- Authentication: Use a Service Account token (Personal Access Tokens are deprecated).
- Permissions: Your token must have at least view access to the organization. Only pipes accessible to the authenticated user are returned.
- Organization ID: The numeric ID of the organization to search within. See Get resource IDs for how to find it.
What is the pipesWithActiveIntegrationsApp query?
The pipesWithActiveIntegrationsApp query returns all pipes within an organization where:
- The authenticated user has access to the pipe (via direct role or group membership), and
- The integrations app is active on that pipe.
Use this query to discover which pipes in your organization are set up for integrations — for example, to drive dashboards, sync systems, or audit integration coverage across an organization.
Step 1: Find your organization ID
Via Pipefy UI
- Open any pipe or board in your browser.
- The URL contains the organization ID:
https://app.pipefy.com/organizations/123456789/... - Organization ID =
123456789(the number after/organizations/).
Via GraphQL query
{
me {
organizations {
id
name
}
}
}
Use the id value from the organization you want to query.
Step 2: Execute the pipesWithActiveIntegrationsApp query
query PipesWithActiveIntegrations($organizationId: ID!) {
pipesWithActiveIntegrationsApp(organizationId: $organizationId) {
id
name
uuid
}
}
Variables:
{
"organizationId": "123456789"
}
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
organizationId | ID! | Yes | The numeric ID of the organization to search within. |
Response fields
Each item in the returned list is a Pipe object. Commonly useful fields:
| Field | Type | Description |
|---|---|---|
id | ID | Numeric pipe ID. |
name | String | The pipe name. |
uuid | String | The pipe UUID (useful for other queries). |
You can request any fields available on the Pipe type, such as description, phases, labels, and more.
Example response
{
"data": {
"pipesWithActiveIntegrationsApp": [
{
"id": "302725964",
"name": "Sales Pipeline",
"uuid": "f06a4ab7-8ca8-48ae-8b86-e7c8fe159bf0"
},
{
"id": "302725965",
"name": "Customer Onboarding",
"uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
]
}
}
An empty array ([]) is returned when no pipes in the organization have the integrations app active, or when the authenticated user does not have access to any such pipes.
Error cases
| Situation | Behavior |
|---|---|
organizationId does not exist | Returns a RESOURCE_NOT_FOUND error. |
| Authenticated user has no access to the organization | Returns a PERMISSION_DENIED error. |
| No matching pipes | Returns an empty array — not an error. |
Key notes
- Scoped to the authenticated user: only pipes the user can access are returned. Pipes with the integrations app active but outside the user's access are not included.
- Group membership is respected: pipes accessible via group roles are included, not only pipes where the user has a direct role.
- Organization-level access required: the authenticated token must have view access to the organization in addition to individual pipe access.
