@shortcut/client
    Preparing search index...

    Interface CustomField

    The entity for this response.

    interface CustomField {
        canonical_name?: string | null;
        created_at?: string;
        description?: string | null;
        enabled?: boolean;
        entity_type?: "custom-field";
        field_type?: string;
        fixed_position?: boolean;
        icon_set_identifier?: string | null;
        id?: string;
        name?: string;
        position?: number | null;
        story_types?: ("feature" | "chore" | "bug")[] | null;
        updated_at?: string;
        uri?: string;
        values?: CustomFieldValue[] | null;
    }
    Index

    Properties

    canonical_name? created_at? description? enabled? entity_type? field_type? fixed_position? icon_set_identifier? id? name? position? story_types? updated_at? uri? values?

    Properties

    canonical_name?: string | null

    The canonical name of a Shortcut-defined Custom Field.

    created_at?: string

    The time/date the Custom Field was created.

    date-time

    description?: string | null

    A description of the Custom Field.

    1024

    enabled?: boolean

    Whether the Custom Field is enabled for the Workspace.

    entity_type?: "custom-field"

    The type of this entity.

    field_type?: string

    The type of the Custom Field (e.g. "enum").

    fixed_position?: boolean

    Whether this Custom Field has a fixed position.

    icon_set_identifier?: string | null

    An identifier for the icon set used for this Custom Field.

    63

    id?: string

    The unique public ID for the Custom Field.

    uuid

    name?: string

    The name of the Custom Field.

    63

    position?: number | null

    The display position of the Custom Field.

    int64

    Optionalstory_types

    story_types?: ("feature" | "chore" | "bug")[] | null

    The story types this Custom Field applies to, if restricted.

    updated_at?: string

    The time/date the Custom Field was last updated.

    date-time

    uri?: string

    A resolvable URI for the entity that will return the full representation.

    2048

    ^https?://.+$

    values?: CustomFieldValue[] | null

    The ordered list of enum values for this Custom Field.

    Settings

    Member Visibility

    On This Page

    Properties