Retrieve Tags of Several Organizations at Once

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: Your token needs permission to see tags in each organization you ask about. Organizations it cannot see are reported back instead of returned.

Step 1. Find the Organization UUIDs

Collect the UUID of every organization you want tags for. You can retrieve each one with:

{
  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

query tagsByOrganization($uuids: [ID!]!) {
  tagsByOrganization(organizationUuids: $uuids) {
    byOrganization {
      organization {
        uuid
        name
      }
      tags {
        uuid
        name
        category {
          uuid
          name
          default
        }
      }
    }
    excludedOrganizations {
      uuid
    }
  }
}

Variables:

{
  "uuids": ["<ORGANIZATION_UUID_1>", "<ORGANIZATION_UUID_2>"]
}

Response Fields

byOrganization: One entry per organization you are allowed to see, ordered by organization name.
- organization: The organization that owns the tags in this entry. Ask for the fields you need, such as uuid and name.
- tags: That organization's tags, ordered by name. Empty when the organization has no tags, or none you are allowed to see.
  - uuid: UUID of the tag.
  - name: Name of the tag.
  - category: The category the tag belongs to, with its uuid, name, and whether it is the default category.
excludedOrganizations: The organizations you asked about that are missing from byOrganization, each with the uuid you sent. Empty when every requested organization was returned.

Example Response

{
  "data": {
    "tagsByOrganization": {
      "byOrganization": [
        {
          "organization": {
            "uuid": "8bd9ce63-a26b-412f-9d27-3a5776e3e16e",
            "name": "Acme"
          },
          "tags": [
            {
              "uuid": "fc0c8145-56cf-42b1-b8fe-0a4fdaf84221",
              "name": "Finance",
              "category": {
                "uuid": "da6680a5-a7be-4971-a7c6-b0b6d39d7f2b",
                "name": "Departments",
                "default": false
              }
            }
          ]
        },
        {
          "organization": {
            "uuid": "457f32ba-59fb-4115-9dff-c20441165f0f",
            "name": "Acme Europe"
          },
          "tags": [
            {
              "uuid": "f88c5ece-ed86-412e-8277-41f2fa1ce4b1",
              "name": "Finance",
              "category": {
                "uuid": "4abfb7ed-fb2e-48cd-97a7-2588df00221b",
                "name": "Departments",
                "default": false
              }
            }
          ]
        }
      ],
      "excludedOrganizations": []
    }
  }
}

Additional Notes

Tags are never merged across organizations. Two organizations can each own a tag named Finance, and those are two different tags with different UUIDs, each returned under its own organization.

You can ask about 1 to 25 organizations in one request. An empty list, or more than 25 entries, is rejected as an invalid argument. Repeating the same UUID is not an error: duplicates are removed before the limit is counted.

An organization appears in excludedOrganizations both when you are not allowed to see its tags and when the UUID does not match any organization. The two cases are deliberately indistinguishable, so no information is disclosed about organizations you cannot access.

Tags that are not visible to members are omitted for anyone who is not an administrator of the organization that owns them, the same rule the single-organization tag queries follow.

This query is read-only and does not modify tags.