initiatives
7 endpoints
get /initiatives
List initiatives
Requires authentication
Returns the org's initiatives, optionally narrowed by project, owner, status, and date window. Unknown filters are ignored.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| projectId | query | integer | no | Filter by project id |
| ownerId | query | integer | no | Filter by owner user id |
| status | query | string (planned | active | at_risk | shipped | cancelled) | no | Filter by status |
| from | query | string | no | Window start (RFC3339) |
| to | query | string | no | Window end (RFC3339) |
Responses
- 200 OK · object
- 401 Unauthorized · apimodel.ErrorEnvelope
post /initiatives
Create an initiative
Requires authentication
Creates a roadmap initiative. Required: title, status, startsAt, endsAt.
Request body: object
No fields documented.
Responses
- 201 Created · object
- 400 Bad Request · apimodel.ErrorEnvelope
- 401 Unauthorized · apimodel.ErrorEnvelope
get /initiatives/{id}
Get an initiative by id
Requires authentication
Returns the initiative including owner and linked tasks when hydrated.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | yes | Initiative id |
Responses
- 200 OK · object
- 401 Unauthorized · apimodel.ErrorEnvelope
- 404 Not Found · apimodel.ErrorEnvelope
patch /initiatives/{id}
Update an initiative
Requires authentication
Partially updates an initiative. Nullable FKs (projectId, ownerId) accept explicit null to clear the column.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | yes | Initiative id |
Request body: object
No fields documented.
Responses
- 200 OK · object
- 400 Bad Request · apimodel.ErrorEnvelope
- 401 Unauthorized · apimodel.ErrorEnvelope
- 404 Not Found · apimodel.ErrorEnvelope
delete /initiatives/{id}
Delete an initiative
Requires authentication
Deletes an initiative and returns a deleted flag.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | yes | Initiative id |
Responses
- 200 OK · object
- 401 Unauthorized · apimodel.ErrorEnvelope
- 404 Not Found · apimodel.ErrorEnvelope
post /initiatives/{id}/issues
Link a task to an initiative
Requires authentication
Links a task under an initiative. Idempotent — succeeds even if the link already existed.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | yes | Initiative id |
Request body: object
No fields documented.
Responses
- 200 OK · object
- 400 Bad Request · apimodel.ErrorEnvelope
- 401 Unauthorized · apimodel.ErrorEnvelope
delete /initiatives/{id}/issues/{taskId}
Unlink a task from an initiative
Requires authentication
Removes a task's link to an initiative and returns an unlinked flag.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | yes | Initiative id |
| taskId | path | integer | yes | Task id |
Responses
- 200 OK · object
- 401 Unauthorized · apimodel.ErrorEnvelope
- 404 Not Found · apimodel.ErrorEnvelope