Get field dependencies by field UUID

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: Ensure your token has permissions to view fields.
Field UUID: Identify the field.

Step 1: Find Your Field UUID

1. Via GraphQL Query

First, you need to find the pipe ID which the target field belongs to.
Open the pipe in your browser.
The URL will include the pipe ID: https://app.pipefy.com/pipes/1234.
Pipe ID = 1234 (the number after /pipes/).
Assuming you need to see a field from a pipe, you can look up its UUID using the pipe query like in the example below.

{
  pipe(id: 1234) {
    start_form_fields {
      uuid
      label
    }
    phases {
      name
      fields {
        uuid
        label
      }
    }
  }
}

If the pipe ID is correct and you are authorized, this is an example response from the query:

{
  "data": {
    "pipe": {
      "start_form_fields": [
        {
          "uuid": "ac7de831-0ce1-4d27-a720-7d5a3b1adc1g",
          "label": "Title"
        }
      ],
      "phases": [
        {
          "name": "Inbox",
          "fields": [
            {
              "uuid": "1ea56732-9009-4b8f-a112-cafe4ec057fe",
              "label": "Assignee"
            },
            {
              "uuid": "704fff25-d872-452a-bd03-4e44aea14c6e",
              "label": "Priority"
            }
          ]
        },
        {
          "name": "Doing",
          "fields": []
        },
        {
          "name": "Done",
          "fields": []
        }
      ]
    }
  }
}

Step 2: Query Field

Use the field query to retrieve all field dependencies from the target field. Below is an example:

{
  query field($fieldUuid: ID!) {
    field(fieldUuid: "hexa7b2-52c0-4x4y-a505-5ex4mpl3") {
      dependentAiAgents {
        nodes {
          id
          name
          active
          url
        }
      }
      dependentAutomations {
        totalCount
        nodes {
          id
          name
          active
          url
        }
      }
      dependentConditionals {
        totalCount
        nodes {
          id
          name
          url
        }
      }
      dependentDynamicFields {
        totalCount
        nodes {
          id
          name
          url
        }
      }
    }
  }
}

Key Fields Explained:

In case of field dependencies, some resources can be loaded:
- AI Agents
  - id: AI Agent unique identifier.
  - name: Name of the AI Agent.
  - active: Whether the AI Agent is active.
  - url: AI Agent's URL.
- Automations
  - id: Automation unique identifier.
  - name: Name of the automation.
  - active: Whether the automation is active.
  - url: Automation's URL.
- Field Conditionals
  - id: Field conditional unique identifier.
  - name: Name of the field conditional.
  - url: Field Conditionals' URL.
- Dynamic Fields
  - id: Dynamic field unique identifier.
  - name: Display name for the dynamic field, referencing the phase it lives in.
  - url: Dynamic field's URL.

Step 3: Execute and Interpret the Response

After running the query, you'll receive a structured JSON response. Here’s an example:

{
  "data": {
    "field": {
      "dependentAiAgents": {
        "edges": [
          {
            "node": {
              "id": "1",
              "name": "Sample agent",
              "active": true,
              "url": "http://app.pipefy.com/pipes/1234/settings/automations/1"
            }
          }
        ]
      },
      "dependentAutomations": {
        "edges": [
          {
            "node": {
              "id": "2",
              "name": "Sample automation",
              "active": false,
              "url": "http://app.pipefy.com/pipes/1234/settings/automations/2"
            }
          }
        ]
      },
      "dependentConditionals": {
        "edges": [
          {
            "node": {
              "id": "1",
              "name": "Sample field conditional",
              "url": "http://app.pipefy.com/pipes/1234/settings/form/conditionals/1"
            }
          }
        ]
      },
      "dependentDynamicFields": {
        "edges": [
          {
            "node": {
              "id": "1",
              "name": "Created in Inbox phase",
              "url": "http://app.pipefy.com/pipes/1234/settings/phases/2/fields/1"
            }
          }
        ]
      }
    }
  }
}

This query provides a quick and effective way to retrieve information about a field dependency.