Skip to main content

Exporting Group Data

Last updated: 2026-05-20

You can export the data for a single group — its metadata, members, settings, and membership rules — to JSON or CSV.

Deprecation notice — the per-group exportGroupData mutation is deprecated in favor of the workspace-wide export job (createGroupsExportJob). It will be removed in a future release. New integrations should use the workspace-wide export (see Workspace-wide exports below).

Permissions — requires group:export on the target group. Available to OWNER and ADMIN by default, or to any member who carries the workspace-level group:export permission.


Exporting a Single Group​

  1. Open the group's Settings tab (/groups/:groupId/settings).
  2. Scroll to Export Group Data.
  3. Choose the format: JSON or CSV.
  4. Click Export.

The backend builds the export synchronously and the file streams back to your browser. Recent exports also appear in the activity feed.


What is included​

DataJSONCSV
Group metadata (name, slug, type, visibility, status, timestamps)xx (header rows)
Group settings (key, value, scope, description, isOverride)xx (settings sheet / section)
Members (entityType, entityId, role, membershipType, source, joinedAt, expiresAt)xx (members sheet / section)
Hierarchy (parent group IDs and child group IDs)xx (hierarchy section)
Membership rules (for DYNAMIC / HYBRID groups)xx (rules section)

Audit log entries are not included in the per-group export — use the workspace-wide audit export instead.


Export format​

  • JSON — single file with a nested structure (group, members, settings, rules, hierarchy). Suitable for programmatic processing or re-importing into another workspace.
  • CSV — multi-section flat tabular format. Suitable for spreadsheets. Each section begins with a # Section: <name> separator.

Workspace-wide exports​

The single-group export is fine for ad-hoc one-off needs. For larger exports (multiple groups, audit data, scheduled jobs) use the workspace-level Export module — createGroupsExportJob runs asynchronously, writes to object storage, and emits a notification when ready. Ask your workspace administrator if you need bulk export access.

The single-group exportGroupData mutation is @deprecated in favor of the workspace-wide export job, and will be removed in a future release.


Large Groups​

For groups with thousands of members the synchronous export may take several seconds. The request is bounded — if it times out, switch to the workspace-wide export job which streams the data instead.


See also​