Export Organization Members

Before You Begin

🔗 Use the GraphQL Playground to execute the mutation 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 must have administrative access to the organization — the mutation requires permission to view the organization and its members.
Organization UUID: Identify the organization whose members you want to export.

Step 1: Find the Organization UUID

The mutation is keyed on the organization UUID (not the numeric ID).

Via GraphQL Query: query the organizations your token can access and read the uuid field. How to get the organization ID.

Step 2: Execute the Mutation

Use the exportOrganizationMembers mutation to generate the export and retrieve the download URL.

mutation {
  exportOrganizationMembers(input: {
    organizationUuid: "organization-uuid-here"
  }) {
    success
    url
    errors
  }
}

Arguments Breakdown

organizationUuid: The UUID of the organization whose members will be exported. Required.

Example Response

{
  "data": {
    "exportOrganizationMembers": {
      "success": true,
      "url": "https://storage.pipefy.com/exports/organization-members.xlsx?signature=...",
      "errors": null
    }
  }
}

success: true when the export was generated successfully.
url: A temporary, signed URL to download the exported file. Download it promptly — signed URLs expire.
errors: A list of messages when the export could not be generated (success is false).

Key Notes

Permissions: If your token lacks administrative access to the organization, the mutation returns a Permission denied error.
Unknown organization: An invalid or unknown organizationUuid returns an Organization not found with UUID: <uuid> error.
Partial failures: When the file cannot be generated or stored, the mutation returns success: false with the reasons in errors rather than a top-level error.
Download URL lifetime: The returned url is a signed link with a limited lifetime — fetch the file soon after the mutation responds.