Use Case Template

Title: Template Agents Query

Before You Begin

GraphQL Playground:
🔗 All examples should be run in the GraphQL Playground.
➡️ New to GraphQL? Review the Playground Basics Guide.
Authentication:
🛠️ Use Service Account tokens (Personal Access Tokens are deprecated).

Prerequisites

Super Admin, Admin or Member role on the Organization.
Organization UUID.

Step 1. Find the Organization ID

Find the organization UUID.

You can retrieve it using this query:

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

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

Step 2. Execute the query

{
  templateAgents(templateId: ID, organizationUuid: UUID) {
    edges {
      node {
        name
      }
    }
  }
}

Sample Response:

{
  "data": {
    "templateAgents": {
      "edges": [
        {
          "node": {
            "name": "Document Processing Agent"
          }
        },
        {
          "node": {
            "name": "Agent to Analyst"
          }
        },
        {
          "node": {
            "name": "Policy & Document Automation Agent"
          }
        },
        {
          "node": {
            "name": "FBI Agent"
          }
        }
      ]
    }
  }
}

The response includes only the name of the agents.