Appearance

Overview ​

Initiatives are high-level strategic goals that help organize and track work across multiple projects, epics, and work items, providing a way to group related work and measure progress toward larger objectives.

Learn more about Initiatives

The Initiatives Object ​

Attributes ​

  • id uuid

    Unique identifier for the initiative

  • name string (required)

    Name of the initiative

  • description string

    Plain text description of the initiative

  • description_html string

    HTML description of the initiative

  • description_stripped string

    Stripped version of the HTML description

  • description_binary string

    Binary description of the initiative

  • lead uuid

    User ID of the initiative lead

  • start_date date

    Start date of the initiative in YYYY-MM-DD format

  • end_date date

    End date of the initiative in YYYY-MM-DD format

  • logo_props object

    Logo properties for the initiative

  • state string

    State of the initiative. Can be: DRAFT, PLANNED, ACTIVE, COMPLETED, CLOSED

  • workspace uuid

    Workspace UUID which is automatically saved

  • created_at timestamp

    The timestamp when the initiative was created

  • updated_at timestamp

    The timestamp when the initiative was last updated

  • created_by uuid

    ID of the user who created the initiative

  • updated_by uuid

    ID of the user who last updated the initiative

Response200
json
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "created_at": "2023-11-19T11:56:55.176802Z",
  "updated_at": "2023-11-19T11:56:55.176809Z",
  "name": "Q1 Product Launch",
  "description": "Launch new product features in Q1",
  "description_html": "<p>Launch new product features in Q1</p>",
  "lead": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "start_date": "2024-01-01",
  "end_date": "2024-03-31",
  "state": "ACTIVE",
  "workspace": "cd4ab5a2-1a5f-4516-a6c6-8da1a9fa5be4"
}