Skip to main content
GET
List initiatives

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

id identifier

Query Parameters

scope
enum<string>

Bounded current-actor accessible-project union; server-derived IDs only. Cannot combine with project_id. Guests exclude projectless initiatives; existing member/admin projectless rights remain.

Available options:
accessible_projects
shape
enum<string>

Opt into the CLI-compatible list envelope response.

Available options:
envelope,
cli
response_shape
enum<string>

Alias for shape; use cli for the CLI-compatible list envelope response.

Available options:
cli,
envelope
project_id
string

Filter initiatives to a project. Required for guests unless scope=accessible_projects is selected; scope cannot combine with an explicit project. Non-guests may omit both for the authorized org-wide list.

q
string

Case-insensitive literal display name/title substring search. Selects bounded retrieval.

q_exact
boolean
default:false

Match the complete display name/title. Selects bounded retrieval.

limit
integer
default:25

Page size in bounded mode; filtering and authorization precede pagination.

Required range: 1 <= x <= 100
offset
integer
default:0

Non-negative safe integer page offset in bounded mode.

Required range: x >= 0

Response

Successful response

The response is of type object.