Filter Authorized Forms to Me by Organization

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

1. Authentication: Use a Service Account token (Personal Access Tokens are deprecated).

Step 1. Find the Organization ID

Step 1: Find the Organization ID

The organization ID can be found on the home page url: https://app.pipefy.com/organizations/<ORGANIZATION_ID>

Step 2. Find the Pipe IDs

Get all Pipe IDs that you want to check. You can find them individually:

• The pipe ID can be found on the pipe page url: https://app.pipefy.com/pipes/<PIPE_ID>

Or retrieve all pipes of the organization visible to you using this query:

{
  organization(id: "<ORGANIZATION_ID>") {
    pipes {
      id
    }
  }
}

For this second option, ensure your token has permissions to view organization.

Step 3: Execute the Query

query filterAuthorizedFormsToMe($organizationId: ID!, $pipeIds: [ID!]!) {
  filterAuthorizedFormsToMe(organizationId: $organizationId, pipeIds: $pipeIds)
}

Response Fields

• filterAuthorizedFormsToMe: Array of pipe IDs that you have permission to fill out start forms for the specified organization.

Example Response

{
  "data": {
    "filterAuthorizedFormsToMe": ["2", "3"]
  }
}

Additional Notes

This query is read-only and does not modify the configuration of pipes or forms.

This query provides a quick and efficient way to retrieve all pipes from your provided list for which you have permission to fill out start forms, based on the organization and pipe IDs passed in the query. The authorization is associated with the "Form Sharing" setting, which you can find inside the pipe configuration.