Interface Category

A Category can be used to associate Objectives.

interface Category {
    archived: boolean;
    color?: string;
    created_at: string;
    entity_type: string;
    external_id?: string;
    global_id: string;
    id: number;
    name: string;
    type: string;
    updated_at: string;
}

Properties

archived color? created_at entity_type external_id? global_id id name type updated_at

Properties

archived

archived: boolean

A true/false boolean indicating if the Category has been archived.

Optionalcolor

color?: string

The hex color to be displayed with the Category (for example, "#ff0000").

Format

css-color

Min Length

1

Pattern

^#[a-fA-F0-9]{6}$

created_at

created_at: string

The time/date that the Category was created.

Format

date-time

entity_type

entity_type: string

A string description of this resource.

Optionalexternal_id

external_id?: string

This field can be set to another unique ID. In the case that the Category has been imported from another tool, the ID in the other tool can be indicated here.

global_id

global_id: string

The Global ID of the Category.

id

id: number

The unique ID of the Category.

Format

int64

name

name: string

The name of the Category.

type

type: string

The type of entity this Category is associated with; currently Milestone or Objective is the only type of Category.

updated_at

updated_at: string

The time/date that the Category was updated.

Format

date-time

Settings

Member Visibility

On This Page

Properties