Skip to content

jira boards list

  • Usage: jira boards list [flags]

List Jira boards visible to the active profile. Use it to discover board IDs for issue listing, JQL building, and profile defaults.

The command serves from the per-profile boards cache when it is fresh. On a first run, stale cache, or --refresh, it reads Jira's agile board API and writes the cache before printing results.

Large sites are capped by default to avoid unbounded pagination. Use --unbounded when you really need every board and are prepared for a longer live read.

Pagination

--all

Return every cached board regardless of --limit

--limit <N>

Maximum boards returned without --all; 0 uses the default

Default: 50

--unbounded

Walk every page (disables the default 100-page / 10 000-board cap)

Cache

--refresh

Force a re-prime even when the cache is fresh

--ttl-minutes <N>

Freshness window before automatic refresh

Default: 40320

Output fields

With --output json, the response envelope's data object carries these fields. Run jira agent schema for the full machine-readable schema.

Field Type Description
boards[].id integer
boards[].name string
boards[].project_keys[] string
boards[].type string
cache_empty boolean
cache_source_state string Disposition observed before any fetch (never the derived empty state).
cache_state string Effective disposition after the read: fresh, stale, missing, malformed, refresh, or empty.
fetched_at string (date-time)
from_cache boolean
truncated boolean
truncated_reason string

Examples

jira boards list # (1)!
jira boards list --refresh # (2)!
jira boards list --refresh --unbounded --output=json # (3)!
  1. Serves from cache, primes on first run
  2. Re-prime from the server before listing
  3. Fetch every board on a large site