Skip to Content

List Spaces

acs2md space list [flags]

Lists all Confluence spaces that your account has access to. Use this to discover space keys before running a conversion.

For most new operators, this is the first real discovery command after doctor.

Examples

# List all spaces in a table (default) acs2md space list # Output as YAML acs2md space list --format yaml # Filter to global spaces only acs2md space list --type global # JSON output acs2md space list --format json # Save to file acs2md space list --format json --output spaces.json # Limit results acs2md space list --limit 20 # Show author names instead of account IDs acs2md space list --resolve-users

Flags

FlagShortDefaultDescription
--format-ftableOutput format: table, json, yaml, csv, tsv
--output-o(stdout)Output file path
--type-t(all)Filter by space type: global, personal
--status-s(all)Filter by space status: current, archived
--limit-l25Total number of spaces to return (0 = all)
--resolve-usersfalseResolve account IDs to display names (makes additional API calls)

acs2md space list auto-paginates in v1.0.0. There is no cursor flag on the current release. When --resolve-users is active, a progress bar appears on stderr while resolving user names.

Sample output (table)

ID KEY NAME TYPE STATUS ───────────────────────────────────────────────────────── 100001 TEAMDOCS Team Documentation global current 100002 ENG Engineering global current 100003 ARCHIVE Archive global archived 100004 ~alice Alice Example personal current 100005 KB Knowledge Base global current

The example above is based on a live tenant response with space identifiers and names anonymized.

Sample output (JSON)

{ "_links": { "self": "", "next": "" }, "results": [ { "id": "100001", "key": "TEAMDOCS", "name": "Team Documentation", "type": "global", "status": "current", "homepageId": "100101", "createdAt": "2024-01-15T09:00:00.000Z", "authorId": "<redacted>" } ] }

Automatic pagination

When there are more results than --limit, acs2md space list continues fetching Confluence API pages until it reaches the requested total or exhausts the result set. That makes it safe to use directly in scripts without a manual cursor loop.

# Return every accessible current global space in one JSON document acs2md space list --type global --status current --limit 0 --format json

Use JSON output when you need to hand the results to automation, reporting, or a stakeholder review process.

Last updated on