Create Multi-Org Users Report Export

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

• A role that grants the Usage Stats permission in each organization you want to include. This is the same permission that controls access to the Usage Statistics page in the Pipefy app — organizations where you do not have it are silently dropped from the export. Organization admins manage this under Roles & Permissions.
• Organization UUIDs for the orgs to aggregate (1 to 25 per request). Use myUsageStatsOrganizations to list eligible orgs.

Step 1. List the organizations you can export

The mutation expects an explicit list of organization UUIDs. The easiest way to obtain that list is the myUsageStatsOrganizations query:

{
  myUsageStatsOrganizations {
    uuid
    name
  }
}

Pick the uuid values you want to include and pass them to createMultiOrgUsersReportExport.

Step 2. Trigger the export

Use the createMultiOrgUsersReportExport mutation with the organization UUIDs. Unlike createMultiOrgUsageReportExport, this mutation has no period or resourceType argument: a users export is a snapshot of current memberships, not a report over a time window, so there is nothing else to configure.

mutation CreateMultiOrgUsersReportExport($organizationUuids: [ID!]!) {
  createMultiOrgUsersReportExport(
    input: {
      organizationUuids: $organizationUuids
    }
  ) {
    status
  }
}

Variables:

{
  "organizationUuids": [
    "8a1c4f10-1111-4d2c-9c2a-abc123def456",
    "b27d5e21-2222-4a3b-8d1b-def456abc789"
  ]
}

Input explanation:

• organizationUuids: List of organization UUIDs to aggregate. Must contain between 1 and 25 entries. Only organizations where the authenticated user has Usage Stats access are included; unknown or unauthorized UUIDs are ignored.

Sample response:

{
  "data": {
    "createMultiOrgUsersReportExport": {
      "status": "created"
    }
  }
}

• status: created when the export was accepted. The report is generated asynchronously and emailed to the requesting user when ready. There is no polling query or download URL in the mutation response.

Key Notes

• One row per membership: The exported XLSX file contains one row per (user, organization) membership across the selected organizations — a user who belongs to more than one selected organization appears once per membership, each row carrying that organization's own Company ID and Company name columns and that membership's own role. Columns: Company ID, Company name, Id, Uuid, Name, Email, Role, Last login, Billable user.
• Email delivery: Like createMultiOrgUsageReportExport, this mutation does not return a download URL. Check the email inbox of the authenticated user for the spreadsheet download link when processing completes.
• Not period-scoped: This mutation exports current organization memberships, not usage over a time window — there is no period argument, and none of the report's columns represent a date range.
• Partial org lists: If some UUIDs are unknown or you lack Usage Stats access, the export still proceeds with the authorized subset.
• Single-organization alternative: To export members for just one organization, use exportOrganizationMembers instead.