Skip to main content
All CollectionsAPIs, Security and IT ManagementAPIs
How to get information from all the pipes and databases from your company via API
How to get information from all the pipes and databases from your company via API
Grazi Sabatini avatar
Written by Grazi Sabatini
Updated over a week ago

🔐 Available on all plans

🎯 For those who want to obtain data from all pipes and databases from

⏩ Content Summary:

Learn how to make the most of Pipefy’s API to obtain the information you need at once:

  • Identify your Company ID.

  • Use queries in the API to obtain information about pipes and databases.

How to obtain information about pipes and databases

You obtain it using Pipefy’s API (GraphiQL) to make queries and mutations (actions) in your processes. Learn how to use Pipefy’s API.

📢 Keep in mind: To be able to use the API, you have to have administrator permissions in your organization. Learn more about roles and permissions in Pipefy.

You’ll be doing a bit of coding here, but this article includes all the necessary steps to make these updates.

First, join your organization; you will need to perform only one action in it. You will also need to open Pipefy’s API.

Inside your organization

To start, you will need your organization ID. It is located in the end of the URL:

In Pipefy’s API

Now that you have the Organization ID, you will need to make a query to obtain pipes and databases information.

Access the API and follow the instructions below:

At the left side of the screen, paste in the following query, replacing the organization ID (the code you identified in the first step) inside the organization.

organization(id: Org ID){

The query will look like this:

On the right side, you will have a list with the information requested:

  • Pipes with their ID and name;

  • Database with their name and URL.

Related content

🎓 Learn how to do more with less with free Pipefy Academy courses!

🌎 Join the Pipefy Community to ask questions, share ideas, stay tuned for product updates and events, and showcase your knowledge with professionals from around the globe!

Did this answer your question?