@shortcut/client
    Preparing search index...

    Interface UploadedFile

    An UploadedFile is any document uploaded to your Shortcut Workspace. Files attached from a third-party service are different: see the Linked Files endpoint.

    interface UploadedFile {
        content_type: string;
        created_at: string;
        description?: null | string;
        entity_type: string;
        external_id?: null | string;
        filename: string;
        group_mention_ids: string[];
        id: number;
        member_mention_ids: string[];
        mention_ids: string[];
        name: string;
        size: number;
        story_ids: number[];
        thumbnail_url?: null | string;
        updated_at?: null | string;
        uploader_id: string;
        url?: null | string;
    }
    Index

    Properties

    content_type created_at description? entity_type external_id? filename group_mention_ids id member_mention_ids mention_ids name size story_ids thumbnail_url? updated_at? uploader_id url?

    Properties

    content_type

    content_type: string

    Free form string corresponding to a text or image file.

    created_at: string

    The time/date that the file was created.

    date-time

    description?: null | string

    The description of the file.

    entity_type: string

    A string description of this resource.

    external_id?: null | string

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

    filename: string

    The name assigned to the file in Shortcut upon upload.

    group_mention_ids: string[]

    The unique IDs of the Groups who are mentioned in the file description.

    id: number

    The unique ID for the file.

    int64

    member_mention_ids: string[]

    The unique IDs of the Members who are mentioned in the file description.

    mention_ids: string[]

    Deprecated: use member_mention_ids.

    name: string

    The optional User-specified name of the file.

    size: number

    The size of the file.

    int64

    story_ids

    story_ids: number[]

    The unique IDs of the Stories associated with this file.

    thumbnail_url?: null | string

    The url where the thumbnail of the file can be found in Shortcut.

    updated_at?: null | string

    The time/date that the file was updated.

    date-time

    uploader_id: string

    The unique ID of the Member who uploaded the file.

    uuid

    url?: null | string

    The URL for the file.

    Settings

    Member Visibility

    On This Page

    Properties