How to obtain the fields' internal ID via API

🔐 Available on all plans

🎯 For those who want to obtain internal information about fields

⏩ Content Summary:

Learn how to make the most of Pipefy’s API to obtain the field's Internal ID:

Identify your Pipe ID;
Use queries in the API to identify the fields’ internal IDs.

How to obtain fields' internal ID

You can obtain it in mass 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, find the pipe containing the fields that you want to obtain; you will need to perform a few actions in it. You will also need to open Pipefy’s API.

Inside the pipe that you want to obtain Internal IDs

To start, you will need the ID of the pipe containing the fields you want to obtain.

Open the pipe. The ID is located in the URL:

In Pipefy’s API

Now that you have the ID of the pipe, you will need to make a query to identify the fields’ internal IDs.

Access the API and follow the instructions below:

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

{
  pipe(id: Pipe ID) {
    id
    name
    start_form_fields {
      label
      id
      internal_id
    }labels {
      name
      id
    }
    phases {
      name
      fields {
        label
        id
        internal_id
      }
    }
  }
}

The query will look like this:

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

Start form fields with their IDs, labels, and Internal_ids.
Phase fields with their IDs, labels, and Internal_ids.

For example, let’s suppose we need to find the internal_id of the Requester name field.

The internal_ID of the field Requester name in the Start form is 364132628.

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!