Skip to content

All resources

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

NameInTypeRequiredDescription
projectIdqueryintegernoFilter by project id
ownerIdqueryintegernoFilter by owner user id
statusquerystring (planned | active | at_risk | shipped | cancelled)noFilter by status
fromquerystringnoWindow start (RFC3339)
toquerystringnoWindow 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

NameInTypeRequiredDescription
idpathintegeryesInitiative 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

NameInTypeRequiredDescription
idpathintegeryesInitiative 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

NameInTypeRequiredDescription
idpathintegeryesInitiative 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

NameInTypeRequiredDescription
idpathintegeryesInitiative 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

NameInTypeRequiredDescription
idpathintegeryesInitiative id
taskIdpathintegeryesTask id

Responses

  • 200 OK · object
  • 401 Unauthorized · apimodel.ErrorEnvelope
  • 404 Not Found · apimodel.ErrorEnvelope