Skip to navigation

PM · Boards · List all accessible PM boards (returns UUIDs for downstream calls)

View as Markdown

List all PM boards the current user can access. Returns board UUIDs and slugs needed for listStatuses, searchTasks, and cloneBoard. Use this first when the user mentions a board by name — match on title from the response.

Filter tips: search=<term> for server-side full-text match on board title/description (DB-backed — prefer this over fetching every board and filtering client-side); primary_type=pm (default) for task boards; is_public=true for public boards only; creator=<user_id> to scope to a creator; modified_after/modified_before for date-range filtering on last modification time (ISO 8601 date, e.g. 2026-01-01). Use page_size=50 to avoid missing boards on paginated workspaces. Always prefer this over searchBoards (removed) — ES index was unreliable.

Authentication

AuthorizationApi-Key

Header authentication of the form Api-Key <token>

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

OrganizationstringOptional

Workspace (organization) ID the request is scoped to.

SpacestringOptional

Optional sub-space ID for further scoping inside the workspace.

Query parameters

searchstringOptional

Server-side full-text search across board title and description.

primary_typeenumOptionalDefaults to pm
Filter by board primary type. Values are lowercase.
Allowed values:
is_publicbooleanOptional
creatorintegerOptional

Filter by creator user ID (integer).

modified_afterdateOptional

Boards modified on or after this date (YYYY-MM-DD).

modified_beforedateOptional

Boards modified on or before this date (YYYY-MM-DD).

expandstringOptional

Comma-separated list of fields to expand inline on the response (FlexFields style, e.g. assignees,tags,time_tracking).

pageintegerOptional

1-based page number for paginated list endpoints.

page_sizeintegerOptional
Page size for paginated list endpoints.

Response

Paginated list of boards.