Skip to content

Initiatives overview ​

Initiatives group projects and work items under one strategic objective.

The initiative object ​

Attributes ​

  • archived_at string (date-time)

    When the record was archived, or null if it is active.

  • created_at string (date-time)

    When the record was created.

  • created_by_id string (uuid)

    The user who created the record.

  • description string

    Free-form description.

  • description_html string

    Rich-text body as HTML. This is the field the Plane editor round-trips.

  • end_date string (date-time)

    End date, as YYYY-MM-DD.

  • id string (uuid)

    Unique identifier.

  • label_ids array of string

    Ids of the associated labels.

  • lead_id string (uuid)

    The related lead.

  • logo_props string

    Editor-owned logo descriptor. Pass back what you read rather than composing it by hand.

  • name string

    Display name.

  • project_ids array of string

    Ids of the associated projects.

  • start_date string (date-time)

    Planned start date, as YYYY-MM-DD.

  • state string

    The state.

Response200
json
{
  "archived_at": null,
  "created_at": "2026-01-14T09:22:41.478363Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "description": "What this is for.",
  "description_html": "<p>Details go here.</p>",
  "end_date": "2026-01-31",
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "label_ids": [["16c61a3a-512a-48ac-b0be-b6b46fe6f430"]],
  "lead_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "logo_props": null,
  "name": "Example name",
  "project_ids": [["16c61a3a-512a-48ac-b0be-b6b46fe6f430"]],
  "start_date": "2026-01-12",
  "state": "DRAFT"
}

Endpoints ​

MethodPathDescription
GET/api/v2/workspaces/{slug}/initiatives/List initiatives
GET/api/v2/workspaces/{slug}/initiatives/{pk}/Get an initiative
POST/api/v2/workspaces/{slug}/initiatives/Create an initiative
PATCH/api/v2/workspaces/{slug}/initiatives/{pk}/Update an initiative
DELETE/api/v2/workspaces/{slug}/initiatives/{pk}/Delete an initiative
POST/api/v2/workspaces/{slug}/initiatives/{pk}/labels/Add or remove initiative labels
POST/api/v2/workspaces/{slug}/initiatives/{pk}/projects/Add or remove initiative projects
POST/api/v2/workspaces/{slug}/initiatives/{pk}/work-items/Add or remove initiative work items

Response shaping ​

Every initiative read accepts ?fields= for sparse responses — see Sparse fields. Errors follow the shared problem+json contract.