Interface Objective

An Objective is a collection of Epics that represent a release or some other large initiative that you are working on.

interface Objective {
    app_url: string;
    archived: boolean;
    categories: Category[];
    completed: boolean;
    completed_at?: string;
    completed_at_override?: string;
    created_at: string;
    description: string;
    entity_type: string;
    global_id: string;
    id: number;
    key_result_ids: string[];
    name: string;
    position: number;
    started: boolean;
    started_at?: string;
    started_at_override?: string;
    state: string;
    stats: ObjectiveStats;
    updated_at: string;
}

Properties

app_url: string

The Shortcut application url for the Objective.

archived: boolean

A boolean indicating whether the Objective has been archived or not.

categories: Category[]

An array of Categories attached to the Objective.

completed: boolean

A true/false boolean indicating if the Objectivehas been completed.

completed_at?: string

The time/date the Objective was completed.

date-time

completed_at_override?: string

A manual override for the time/date the Objective was completed.

date-time

created_at: string

The time/date the Objective was created.

date-time

description: string

The Objective's description.

entity_type: string

A string description of this resource.

global_id: string
id: number

The unique ID of the Objective.

int64

key_result_ids: string[]

The IDs of the Key Results associated with the Objective.

name: string

The name of the Objective.

position: number

A number representing the position of the Objective in relation to every other Objective within the Workspace.

int64

started: boolean

A true/false boolean indicating if the Objective has been started.

started_at?: string

The time/date the Objective was started.

date-time

started_at_override?: string

A manual override for the time/date the Objective was started.

date-time

state: string

The workflow state that the Objective is in.

A group of calculated values for this Objective.

updated_at: string

The time/date the Objective was updated.

date-time