Class ShortcutV4Client

Shortcut REST API v4 client.

Generated operations take the workspace slug as their first argument; workspace(slug) returns the same operations with it applied. Requests that fail reject with the Response, so isShortcutV4RequestError narrows a caught error to one with a typed .error body, .status, and the .request that produced it. Every request is aborted with a TimeoutError after timeoutMs.

const client = new ShortcutV4Client({ token });
const { entity } = await client.workspace('acme').getStory(123, { fields: 'name,team' });

Hierarchy

Api<string>
- ShortcutV4Client

Index

Constructors

constructor

Properties

baseUrl timeoutMs

Methods

Constructors

constructor

new ShortcutV4Client(options: ShortcutV4ClientOptions): ShortcutV4Client
Parameters
- options: ShortcutV4ClientOptions
Returns ShortcutV4Client
Overrides Api<string>.constructor
- Defined in src/v4/ShortcutV4Client.ts:239

Properties

baseUrl

baseUrl: string = "https://api.app.shortcut.com"

`Readonly`timeoutMs

timeoutMs: number

Methods

abortRequest

abortRequest(cancelToken: CancelToken): void
Parameters
- cancelToken: CancelToken
Returns void
Inherited from Api.abortRequest
- Defined in src/v4/generated/http-client.ts:203

`Protected`addArrayQueryParam

addArrayQueryParam(query: QueryParamsType, key: string): any
Parameters
- query: QueryParamsType
- key: string
Returns any
Inherited from Api.addArrayQueryParam
- Defined in src/v4/generated/http-client.ts:113

addDocToCollection

addDocToCollection(
    workspaceSlug: string,
    docPublicId: string,
    collectionPublicId: string,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<DocEntityWrapper>
Parameters
- workspaceSlug: string
- docPublicId: string
- collectionPublicId: string
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<DocEntityWrapper>
Description
Add Doc to Collection adds the Doc to the chosen Collection, preserving its other Collection memberships, and returns the updated Doc. Requires write access to the Doc.

Name
AddDocToCollection

Request
PUT:/api/v4/{workspace-slug}/documents/{doc-public-id}/collections/{collection-public-id}

Secure
Inherited from Api.addDocToCollection
- Defined in src/v4/generated/Api.ts:1456

`Protected`addQueryParam

addQueryParam(query: QueryParamsType, key: string): string
Parameters
- query: QueryParamsType
- key: string
Returns string
Inherited from Api.addQueryParam
- Defined in src/v4/generated/http-client.ts:109

`Protected`addQueryParams

addQueryParams(rawQuery?: QueryParamsType): string
Parameters
- OptionalrawQuery: QueryParamsType
Returns string
Inherited from Api.addQueryParams
- Defined in src/v4/generated/http-client.ts:132

bulkCreateCategories

bulkCreateCategories(
    workspaceSlug: string,
    data: BulkCreateCategoriesParams,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "name" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<CategoryEntityListWrapper>
Parameters
- workspaceSlug: string
- data: BulkCreateCategoriesParams
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "name" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<CategoryEntityListWrapper>
Description
Bulk Create Categories creates multiple Categories, and returns a paginated list of the created Categories.

Name
BulkCreateCategories

Request
POST:/api/v4/{workspace-slug}/categories/bulk

Secure
Inherited from Api.bulkCreateCategories
- Defined in src/v4/generated/Api.ts:605

bulkCreateDocs

bulkCreateDocs(
    workspaceSlug: string,
    data: BulkCreateDocsParams,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "created_at" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<DocEntityListWrapper>
Parameters
- workspaceSlug: string
- data: BulkCreateDocsParams
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "created_at" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "created_at" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<DocEntityListWrapper>
Description
Bulk Create Docs creates multiple Docs, and returns a paginated list of the created Docs.

Name
BulkCreateDocs

Request
POST:/api/v4/{workspace-slug}/documents/bulk

Secure
Inherited from Api.bulkCreateDocs
- Defined in src/v4/generated/Api.ts:1265

bulkCreateEntityTemplates

bulkCreateEntityTemplates(
    workspaceSlug: string,
    data: BulkCreateEntityTemplatesParams,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<EntityTemplateEntityListWrapper>
Parameters
- workspaceSlug: string
- data: BulkCreateEntityTemplatesParams
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<EntityTemplateEntityListWrapper>
Description
Bulk Create Entity Templates creates multiple Entity Templates, and returns a paginated list of the created Entity Templates.

Name
BulkCreateEntityTemplates

Request
POST:/api/v4/{workspace-slug}/entity-templates/bulk

Secure
Inherited from Api.bulkCreateEntityTemplates
- Defined in src/v4/generated/Api.ts:1627

bulkCreateEpicComments

bulkCreateEpicComments(
    workspaceSlug: string,
    epicPublicId: number,
    data: BulkCreateEpicCommentsParams,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "created_at" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<EpicCommentEntityListWrapper>
Parameters
- workspaceSlug: string
- epicPublicId: number
- data: BulkCreateEpicCommentsParams
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "created_at" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "created_at" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<EpicCommentEntityListWrapper>
Description
Bulk Create Epic Comments creates multiple Comments on an Epic, and returns a paginated list of the created Comments.

Name
BulkCreateEpicComments

Request
POST:/api/v4/{workspace-slug}/epics/{epic-public-id}/comments/bulk

Secure
Inherited from Api.bulkCreateEpicComments
- Defined in src/v4/generated/Api.ts:2534

bulkCreateEpics

bulkCreateEpics(
    workspaceSlug: string,
    data: BulkCreateEpicsParams,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<EpicEntityListWrapper>
Parameters
- workspaceSlug: string
- data: BulkCreateEpicsParams
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<EpicEntityListWrapper>
Description
Bulk Create Epics creates multiple Epics, and returns a paginated list of the created Epics.

Name
BulkCreateEpics

Request
POST:/api/v4/{workspace-slug}/epics/bulk

Secure
Inherited from Api.bulkCreateEpics
- Defined in src/v4/generated/Api.ts:1930

bulkCreateIterations

bulkCreateIterations(
    workspaceSlug: string,
    data: BulkCreateIterationsParams,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "updated_at" | "start_date";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<IterationEntityListWrapper>
Parameters
- workspaceSlug: string
- data: BulkCreateIterationsParams
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "updated_at" | "start_date";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at" | "start_date"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<IterationEntityListWrapper>
Description
Bulk Create Iterations creates multiple Iterations, and returns a paginated list of the created Iterations.

Name
BulkCreateIterations

Request
POST:/api/v4/{workspace-slug}/iterations/bulk

Secure
Inherited from Api.bulkCreateIterations
- Defined in src/v4/generated/Api.ts:3243

bulkCreateLabels

bulkCreateLabels(
    workspaceSlug: string,
    data: BulkCreateLabelsParams,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "name" | "created_at" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<LabelEntityListWrapper>
Parameters
- workspaceSlug: string
- data: BulkCreateLabelsParams
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "name" | "created_at" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "created_at" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<LabelEntityListWrapper>
Description
Bulk Create Labels creates multiple Labels, and returns a paginated list of the created Labels.

Name
BulkCreateLabels

Request
POST:/api/v4/{workspace-slug}/labels/bulk

Secure
Inherited from Api.bulkCreateLabels
- Defined in src/v4/generated/Api.ts:3917

bulkCreateLinkedFiles

bulkCreateLinkedFiles(
    workspaceSlug: string,
    data: BulkCreateLinkedFilesParams,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<LinkedFileEntityListWrapper>
Parameters
- workspaceSlug: string
- data: BulkCreateLinkedFilesParams
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<LinkedFileEntityListWrapper>
Description
Bulk Create Linked Files creates multiple Linked Files, and returns a paginated list of the created Linked Files.

Name
BulkCreateLinkedFiles

Request
POST:/api/v4/{workspace-slug}/linked-files/bulk

Secure
Inherited from Api.bulkCreateLinkedFiles
- Defined in src/v4/generated/Api.ts:4232

bulkCreateObjectives

bulkCreateObjectives(
    workspaceSlug: string,
    data: BulkCreateObjectivesParams,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<ObjectiveEntityListWrapper>
Parameters
- workspaceSlug: string
- data: BulkCreateObjectivesParams
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<ObjectiveEntityListWrapper>
Description
Bulk Create Objectives creates multiple Objectives, and returns a paginated list of the created Objectives.

Name
BulkCreateObjectives

Request
POST:/api/v4/{workspace-slug}/objectives/bulk

Secure
Inherited from Api.bulkCreateObjectives
- Defined in src/v4/generated/Api.ts:4794

bulkCreateStories

bulkCreateStories(
    workspaceSlug: string,
    data: BulkCreateStoriesParams,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "created_at" | "updated_at" | "position";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StoryEntityListWrapper>
Parameters
- workspaceSlug: string
- data: BulkCreateStoriesParams
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "created_at" | "updated_at" | "position";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "created_at" | "updated_at" | "position"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<StoryEntityListWrapper>
Description
Bulk Create Stories creates multiple Stories, and returns a paginated list of the created Stories.

Name
BulkCreateStories

Request
POST:/api/v4/{workspace-slug}/stories/bulk

Secure
Inherited from Api.bulkCreateStories
- Defined in src/v4/generated/Api.ts:5900

bulkCreateStoryChecklistItems

bulkCreateStoryChecklistItems(
    workspaceSlug: string,
    storyPublicId: number,
    data: BulkCreateStoryChecklistItemsParams,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "position";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StoryChecklistItemEntityListWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- data: BulkCreateStoryChecklistItemsParams
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "position";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "position"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<StoryChecklistItemEntityListWrapper>
Description
Bulk Create Story Checklist Items creates multiple Checklist Items on a Story, and returns a paginated list of the created Checklist Items.

Name
BulkCreateStoryChecklistItems

Request
POST:/api/v4/{workspace-slug}/stories/{story-public-id}/checklist-items/bulk

Secure
Inherited from Api.bulkCreateStoryChecklistItems
- Defined in src/v4/generated/Api.ts:7015

bulkCreateStoryComments

bulkCreateStoryComments(
    workspaceSlug: string,
    storyPublicId: number,
    data: BulkCreateStoryCommentsParams,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "position";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StoryCommentEntityListWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- data: BulkCreateStoryCommentsParams
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "position";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "position"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<StoryCommentEntityListWrapper>
Description
Bulk Create Story Comments creates multiple Comments on a Story, and returns a paginated list of the created Comments.

Name
BulkCreateStoryComments

Request
POST:/api/v4/{workspace-slug}/stories/{story-public-id}/comments/bulk

Secure
Inherited from Api.bulkCreateStoryComments
- Defined in src/v4/generated/Api.ts:6607

bulkCreateStoryLinks

bulkCreateStoryLinks(
    workspaceSlug: string,
    data: BulkCreateStoryLinksParams,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StoryLinkEntityListWrapper>
Parameters
- workspaceSlug: string
- data: BulkCreateStoryLinksParams
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<StoryLinkEntityListWrapper>
Description
Bulk Create Story Links creates multiple Story Links, and returns a paginated list of the created Story Links.

Name
BulkCreateStoryLinks

Request
POST:/api/v4/{workspace-slug}/story-links/bulk

Secure
Inherited from Api.bulkCreateStoryLinks
- Defined in src/v4/generated/Api.ts:7623

bulkCreateTeams

bulkCreateTeams(
    workspaceSlug: string,
    data: BulkCreateTeamsParams,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "name" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<TeamEntityListWrapper>
Parameters
- workspaceSlug: string
- data: BulkCreateTeamsParams
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "name" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<TeamEntityListWrapper>
Description
Creates multiple Teams and returns a paginated list of the created Teams.

Name
BulkCreateTeams

Request
POST:/api/v4/{workspace-slug}/teams/bulk

Secure
Inherited from Api.bulkCreateTeams
- Defined in src/v4/generated/Api.ts:7829

bulkDeleteCategories

bulkDeleteCategories(
    workspaceSlug: string,
    data: BulkDeleteCategoriesParams,
    params?: RequestParams,
): Promise<void>
Parameters
- workspaceSlug: string
- data: BulkDeleteCategoriesParams
- params: RequestParams = {}
Returns Promise<void>
Description
Bulk Delete Categories deletes multiple Categories.

Name
BulkDeleteCategories

Request
DELETE:/api/v4/{workspace-slug}/categories/bulk

Secure
Inherited from Api.bulkDeleteCategories
- Defined in src/v4/generated/Api.ts:543

bulkDeleteCustomFields

bulkDeleteCustomFields(
    workspaceSlug: string,
    data: BulkDeleteCustomFieldsParams,
    params?: RequestParams,
): Promise<void>
Parameters
- workspaceSlug: string
- data: BulkDeleteCustomFieldsParams
- params: RequestParams = {}
Returns Promise<void>
Description
Bulk Delete Custom Fields removes multiple Custom Fields from the Workspace.

Name
BulkDeleteCustomFields

Request
DELETE:/api/v4/{workspace-slug}/custom-fields/bulk

Secure
Inherited from Api.bulkDeleteCustomFields
- Defined in src/v4/generated/Api.ts:1030

bulkDeleteEntityTemplates

bulkDeleteEntityTemplates(
    workspaceSlug: string,
    data: BulkDeleteEntityTemplatesParams,
    params?: RequestParams,
): Promise<void>
Parameters
- workspaceSlug: string
- data: BulkDeleteEntityTemplatesParams
- params: RequestParams = {}
Returns Promise<void>
Description
Bulk Delete Entity Templates removes multiple Entity Templates from the Workspace.

Name
BulkDeleteEntityTemplates

Request
DELETE:/api/v4/{workspace-slug}/entity-templates/bulk

Secure
Inherited from Api.bulkDeleteEntityTemplates
- Defined in src/v4/generated/Api.ts:1565

bulkDeleteEpicComments

bulkDeleteEpicComments(
    workspaceSlug: string,
    epicPublicId: number,
    data: BulkDeleteEpicCommentsParams,
    params?: RequestParams,
): Promise<void>
Parameters
- workspaceSlug: string
- epicPublicId: number
- data: BulkDeleteEpicCommentsParams
- params: RequestParams = {}
Returns Promise<void>
Description
Bulk Delete Epic Comments deletes multiple Comments from an Epic.

Name
BulkDeleteEpicComments

Request
DELETE:/api/v4/{workspace-slug}/epics/{epic-public-id}/comments/bulk

Secure
Inherited from Api.bulkDeleteEpicComments
- Defined in src/v4/generated/Api.ts:2470

bulkDeleteEpics

bulkDeleteEpics(
    workspaceSlug: string,
    data: BulkDeleteEpicsParams,
    query?: { force?: boolean },
    params?: RequestParams,
): Promise<void>
Parameters
- workspaceSlug: string
- data: BulkDeleteEpicsParams
- Optionalquery: { force?: boolean }
  - Optionalforce?: boolean
    Forces deletion of the Epics, overriding the check that they are archived.
- params: RequestParams = {}
Returns Promise<void>
Description
Bulk Delete Epics deletes multiple Epics. The Epics must be archived unless force is set.

Name
BulkDeleteEpics

Request
DELETE:/api/v4/{workspace-slug}/epics/bulk

Secure
Inherited from Api.bulkDeleteEpics
- Defined in src/v4/generated/Api.ts:1863

bulkDeleteFiles

bulkDeleteFiles(
    workspaceSlug: string,
    data: BulkDeleteFilesParams,
    params?: RequestParams,
): Promise<void>
Parameters
- workspaceSlug: string
- data: BulkDeleteFilesParams
- params: RequestParams = {}
Returns Promise<void>
Description
Bulk Delete Files deletes multiple Files from the Workspace.

Name
BulkDeleteFiles

Request
DELETE:/api/v4/{workspace-slug}/files/bulk

Secure
Inherited from Api.bulkDeleteFiles
- Defined in src/v4/generated/Api.ts:2936

bulkDeleteIterations

bulkDeleteIterations(
    workspaceSlug: string,
    data: BulkDeleteIterationsParams,
    params?: RequestParams,
): Promise<void>
Parameters
- workspaceSlug: string
- data: BulkDeleteIterationsParams
- params: RequestParams = {}
Returns Promise<void>
Description
Bulk Delete Iterations deletes multiple Iterations.

Name
BulkDeleteIterations

Request
DELETE:/api/v4/{workspace-slug}/iterations/bulk

Secure
Inherited from Api.bulkDeleteIterations
- Defined in src/v4/generated/Api.ts:3181

bulkDeleteLabels

bulkDeleteLabels(
    workspaceSlug: string,
    data: BulkDeleteLabelsParams,
    params?: RequestParams,
): Promise<void>
Parameters
- workspaceSlug: string
- data: BulkDeleteLabelsParams
- params: RequestParams = {}
Returns Promise<void>
Description
Bulk Delete Labels deletes multiple Labels.

Name
BulkDeleteLabels

Request
DELETE:/api/v4/{workspace-slug}/labels/bulk

Secure
Inherited from Api.bulkDeleteLabels
- Defined in src/v4/generated/Api.ts:3855

bulkDeleteLinkedFiles

bulkDeleteLinkedFiles(
    workspaceSlug: string,
    data: BulkDeleteLinkedFilesParams,
    params?: RequestParams,
): Promise<void>
Parameters
- workspaceSlug: string
- data: BulkDeleteLinkedFilesParams
- params: RequestParams = {}
Returns Promise<void>
Description
Bulk Delete Linked Files deletes multiple Linked Files.

Name
BulkDeleteLinkedFiles

Request
DELETE:/api/v4/{workspace-slug}/linked-files/bulk

Secure
Inherited from Api.bulkDeleteLinkedFiles
- Defined in src/v4/generated/Api.ts:4170

bulkDeleteObjectives

bulkDeleteObjectives(
    workspaceSlug: string,
    data: BulkDeleteObjectivesParams,
    params?: RequestParams,
): Promise<void>
Parameters
- workspaceSlug: string
- data: BulkDeleteObjectivesParams
- params: RequestParams = {}
Returns Promise<void>
Description
Bulk Delete Objectives deletes multiple Objectives.

Name
BulkDeleteObjectives

Request
DELETE:/api/v4/{workspace-slug}/objectives/bulk

Secure
Inherited from Api.bulkDeleteObjectives
- Defined in src/v4/generated/Api.ts:4732

bulkDeleteStories

bulkDeleteStories(
    workspaceSlug: string,
    data: BulkDeleteStoriesParams,
    query?: { force?: boolean },
    params?: RequestParams,
): Promise<void>
Parameters
- workspaceSlug: string
- data: BulkDeleteStoriesParams
- Optionalquery: { force?: boolean }
  - Optionalforce?: boolean
    Forces deletion of the Stories, overriding the check that they are archived.
- params: RequestParams = {}
Returns Promise<void>
Description
Bulk Delete Stories deletes multiple Stories. The Stories must be archived unless force is set.

Name
BulkDeleteStories

Request
DELETE:/api/v4/{workspace-slug}/stories/bulk

Secure
Inherited from Api.bulkDeleteStories
- Defined in src/v4/generated/Api.ts:5833

bulkDeleteStoryChecklistItems

bulkDeleteStoryChecklistItems(
    workspaceSlug: string,
    storyPublicId: number,
    data: BulkDeleteStoryChecklistItemsParams,
    params?: RequestParams,
): Promise<void>
Parameters
- workspaceSlug: string
- storyPublicId: number
- data: BulkDeleteStoryChecklistItemsParams
- params: RequestParams = {}
Returns Promise<void>
Description
Bulk Delete Story Checklist Items deletes multiple Checklist Items from a Story.

Name
BulkDeleteStoryChecklistItems

Request
DELETE:/api/v4/{workspace-slug}/stories/{story-public-id}/checklist-items/bulk

Secure
Inherited from Api.bulkDeleteStoryChecklistItems
- Defined in src/v4/generated/Api.ts:6951

bulkDeleteStoryComments

bulkDeleteStoryComments(
    workspaceSlug: string,
    storyPublicId: number,
    data: BulkDeleteStoryCommentsParams,
    params?: RequestParams,
): Promise<void>
Parameters
- workspaceSlug: string
- storyPublicId: number
- data: BulkDeleteStoryCommentsParams
- params: RequestParams = {}
Returns Promise<void>
Description
Bulk Delete Story Comments deletes multiple Comments from a Story.

Name
BulkDeleteStoryComments

Request
DELETE:/api/v4/{workspace-slug}/stories/{story-public-id}/comments/bulk

Secure
Inherited from Api.bulkDeleteStoryComments
- Defined in src/v4/generated/Api.ts:6543

bulkDeleteStoryLinks

bulkDeleteStoryLinks(
    workspaceSlug: string,
    data: BulkDeleteStoryLinksParams,
    params?: RequestParams,
): Promise<void>
Parameters
- workspaceSlug: string
- data: BulkDeleteStoryLinksParams
- params: RequestParams = {}
Returns Promise<void>
Description
Bulk Delete Story Links deletes multiple Story Links.

Name
BulkDeleteStoryLinks

Request
DELETE:/api/v4/{workspace-slug}/story-links/bulk

Secure
Inherited from Api.bulkDeleteStoryLinks
- Defined in src/v4/generated/Api.ts:7561

bulkUpdateCategories

bulkUpdateCategories(
    workspaceSlug: string,
    data: BulkUpdateCategoriesParams,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "name" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<CategoryEntityListWrapper>
Parameters
- workspaceSlug: string
- data: BulkUpdateCategoriesParams
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "name" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<CategoryEntityListWrapper>
Description
Bulk Update Categories updates multiple Categories, and returns a paginated list of the updated Categories.

Name
BulkUpdateCategories

Request
PATCH:/api/v4/{workspace-slug}/categories/bulk

Secure
Inherited from Api.bulkUpdateCategories
- Defined in src/v4/generated/Api.ts:564

bulkUpdateCustomFields

bulkUpdateCustomFields(
    workspaceSlug: string,
    data: BulkUpdateCustomFieldsParams,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "name" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<CustomFieldEntityListWrapper>
Parameters
- workspaceSlug: string
- data: BulkUpdateCustomFieldsParams
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "name" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<CustomFieldEntityListWrapper>
Description
Bulk Update Custom Fields updates multiple Custom Fields, and returns a paginated list of the updated Custom Fields.

Name
BulkUpdateCustomFields

Request
PATCH:/api/v4/{workspace-slug}/custom-fields/bulk

Secure
Inherited from Api.bulkUpdateCustomFields
- Defined in src/v4/generated/Api.ts:1051

bulkUpdateEntityTemplates

bulkUpdateEntityTemplates(
    workspaceSlug: string,
    data: BulkUpdateEntityTemplatesParams,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<EntityTemplateEntityListWrapper>
Parameters
- workspaceSlug: string
- data: BulkUpdateEntityTemplatesParams
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<EntityTemplateEntityListWrapper>
Description
Bulk Update Entity Templates updates multiple Entity Templates, and returns a paginated list of the updated Entity Templates.

Name
BulkUpdateEntityTemplates

Request
PATCH:/api/v4/{workspace-slug}/entity-templates/bulk

Secure
Inherited from Api.bulkUpdateEntityTemplates
- Defined in src/v4/generated/Api.ts:1586

bulkUpdateEpicComments

bulkUpdateEpicComments(
    workspaceSlug: string,
    epicPublicId: number,
    data: BulkUpdateEpicCommentsParams,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "created_at" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<EpicCommentEntityListWrapper>
Parameters
- workspaceSlug: string
- epicPublicId: number
- data: BulkUpdateEpicCommentsParams
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "created_at" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "created_at" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<EpicCommentEntityListWrapper>
Description
Bulk Update Epic Comments updates multiple Comments on an Epic, and returns a paginated list of the updated Comments.

Name
BulkUpdateEpicComments

Request
PATCH:/api/v4/{workspace-slug}/epics/{epic-public-id}/comments/bulk

Secure
Inherited from Api.bulkUpdateEpicComments
- Defined in src/v4/generated/Api.ts:2492

bulkUpdateEpics

bulkUpdateEpics(
    workspaceSlug: string,
    data: BulkUpdateEpicsParams,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<EpicEntityListWrapper>
Parameters
- workspaceSlug: string
- data: BulkUpdateEpicsParams
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<EpicEntityListWrapper>
Description
Bulk Update Epics updates multiple Epics, and returns a paginated list of the updated Epics.

Name
BulkUpdateEpics

Request
PATCH:/api/v4/{workspace-slug}/epics/bulk

Secure
Inherited from Api.bulkUpdateEpics
- Defined in src/v4/generated/Api.ts:1889

bulkUpdateIterations

bulkUpdateIterations(
    workspaceSlug: string,
    data: BulkUpdateIterationsParams,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "updated_at" | "start_date";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<IterationEntityListWrapper>
Parameters
- workspaceSlug: string
- data: BulkUpdateIterationsParams
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "updated_at" | "start_date";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at" | "start_date"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<IterationEntityListWrapper>
Description
Bulk Update Iterations updates multiple Iterations, and returns a paginated list of the updated Iterations.

Name
BulkUpdateIterations

Request
PATCH:/api/v4/{workspace-slug}/iterations/bulk

Secure
Inherited from Api.bulkUpdateIterations
- Defined in src/v4/generated/Api.ts:3202

bulkUpdateLabels

bulkUpdateLabels(
    workspaceSlug: string,
    data: BulkUpdateLabelsParams,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "name" | "created_at" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<LabelEntityListWrapper>
Parameters
- workspaceSlug: string
- data: BulkUpdateLabelsParams
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "name" | "created_at" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "created_at" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<LabelEntityListWrapper>
Description
Bulk Update Labels updates multiple Labels, and returns a paginated list of the updated Labels.

Name
BulkUpdateLabels

Request
PATCH:/api/v4/{workspace-slug}/labels/bulk

Secure
Inherited from Api.bulkUpdateLabels
- Defined in src/v4/generated/Api.ts:3876

bulkUpdateLinkedFiles

bulkUpdateLinkedFiles(
    workspaceSlug: string,
    data: BulkUpdateLinkedFilesParams,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<LinkedFileEntityListWrapper>
Parameters
- workspaceSlug: string
- data: BulkUpdateLinkedFilesParams
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<LinkedFileEntityListWrapper>
Description
Bulk Update Linked Files updates multiple Linked Files, and returns a paginated list of the updated Linked Files.

Name
BulkUpdateLinkedFiles

Request
PATCH:/api/v4/{workspace-slug}/linked-files/bulk

Secure
Inherited from Api.bulkUpdateLinkedFiles
- Defined in src/v4/generated/Api.ts:4191

bulkUpdateMembers

bulkUpdateMembers(
    workspaceSlug: string,
    data: BulkUpdateMembersParams,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_disabled" | "include_disabled";
        limit?: number;
        order_by?: "name";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<MemberEntityListWrapper>
Parameters
- workspaceSlug: string
- data: BulkUpdateMembersParams
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_disabled" | "include_disabled";
      limit?: number;
      order_by?: "name";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_disabled" | "include_disabled"
    Filter options (default: :exclude_disabled).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<MemberEntityListWrapper>
Description
Bulk Update Members updates multiple Members and returns a paginated list of the updated Members.

Name
BulkUpdateMembers

Request
PATCH:/api/v4/{workspace-slug}/members/bulk

Secure
Inherited from Api.bulkUpdateMembers
- Defined in src/v4/generated/Api.ts:4498

bulkUpdateObjectives

bulkUpdateObjectives(
    workspaceSlug: string,
    data: BulkUpdateObjectivesParams,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<ObjectiveEntityListWrapper>
Parameters
- workspaceSlug: string
- data: BulkUpdateObjectivesParams
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<ObjectiveEntityListWrapper>
Description
Bulk Update Objectives updates multiple Objectives, and returns a paginated list of the updated Objectives.

Name
BulkUpdateObjectives

Request
PATCH:/api/v4/{workspace-slug}/objectives/bulk

Secure
Inherited from Api.bulkUpdateObjectives
- Defined in src/v4/generated/Api.ts:4753

bulkUpdateStories

bulkUpdateStories(
    workspaceSlug: string,
    data: BulkUpdateStoriesParams,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "created_at" | "updated_at" | "position";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StoryEntityListWrapper>
Parameters
- workspaceSlug: string
- data: BulkUpdateStoriesParams
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "created_at" | "updated_at" | "position";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "created_at" | "updated_at" | "position"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<StoryEntityListWrapper>
Description
Bulk Update Stories updates multiple Stories, and returns a paginated list of the updated Stories.

Name
BulkUpdateStories

Request
PATCH:/api/v4/{workspace-slug}/stories/bulk

Secure
Inherited from Api.bulkUpdateStories
- Defined in src/v4/generated/Api.ts:5859

bulkUpdateStoryChecklistItems

bulkUpdateStoryChecklistItems(
    workspaceSlug: string,
    storyPublicId: number,
    data: BulkUpdateStoryChecklistItemsParams,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "position";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StoryChecklistItemEntityListWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- data: BulkUpdateStoryChecklistItemsParams
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "position";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "position"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<StoryChecklistItemEntityListWrapper>
Description
Bulk Update Story Checklist Items updates multiple Checklist Items on a Story, and returns a paginated list of the updated Checklist Items.

Name
BulkUpdateStoryChecklistItems

Request
PATCH:/api/v4/{workspace-slug}/stories/{story-public-id}/checklist-items/bulk

Secure
Inherited from Api.bulkUpdateStoryChecklistItems
- Defined in src/v4/generated/Api.ts:6973

bulkUpdateStoryComments

bulkUpdateStoryComments(
    workspaceSlug: string,
    storyPublicId: number,
    data: BulkUpdateStoryCommentsParams,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "position";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StoryCommentEntityListWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- data: BulkUpdateStoryCommentsParams
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "position";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "position"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<StoryCommentEntityListWrapper>
Description
Bulk Update Story Comments updates multiple Comments on a Story, and returns a paginated list of the updated Comments.

Name
BulkUpdateStoryComments

Request
PATCH:/api/v4/{workspace-slug}/stories/{story-public-id}/comments/bulk

Secure
Inherited from Api.bulkUpdateStoryComments
- Defined in src/v4/generated/Api.ts:6565

bulkUpdateStoryLinks

bulkUpdateStoryLinks(
    workspaceSlug: string,
    data: BulkUpdateStoryLinksParams,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StoryLinkEntityListWrapper>
Parameters
- workspaceSlug: string
- data: BulkUpdateStoryLinksParams
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<StoryLinkEntityListWrapper>
Description
Bulk Update Story Links updates multiple Story Links, and returns a paginated list of the updated Story Links.

Name
BulkUpdateStoryLinks

Request
PATCH:/api/v4/{workspace-slug}/story-links/bulk

Secure
Inherited from Api.bulkUpdateStoryLinks
- Defined in src/v4/generated/Api.ts:7582

bulkUpdateTeams

bulkUpdateTeams(
    workspaceSlug: string,
    data: BulkUpdateTeamsParams,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "name" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<TeamEntityListWrapper>
Parameters
- workspaceSlug: string
- data: BulkUpdateTeamsParams
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "name" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<TeamEntityListWrapper>
Description
Updates multiple Teams and returns a paginated list of the updated Teams.

Name
BulkUpdateTeams

Request
PATCH:/api/v4/{workspace-slug}/teams/bulk

Secure
Inherited from Api.bulkUpdateTeams
- Defined in src/v4/generated/Api.ts:7788

`Protected`createAbortSignal

createAbortSignal(cancelToken: CancelToken): AbortSignal | undefined
Parameters
- cancelToken: CancelToken
Returns AbortSignal | undefined
Inherited from Api.createAbortSignal
- Defined in src/v4/generated/http-client.ts:187

createCategory

createCategory(
    workspaceSlug: string,
    data: CreateCategoryParams,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<CategoryEntityWrapper>
Parameters
- workspaceSlug: string
- data: CreateCategoryParams
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<CategoryEntityWrapper>
Description
Create Category allows you to create a new Category in Shortcut.

Name
CreateCategory

Request
POST:/api/v4/{workspace-slug}/categories

Secure
Inherited from Api.createCategory
- Defined in src/v4/generated/Api.ts:517

createCollection

createCollection(
    workspaceSlug: string,
    data: CreateCollectionParams,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<CollectionEntityWrapper>
Parameters
- workspaceSlug: string
- data: CreateCollectionParams
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<CollectionEntityWrapper>
Description
Create Collection allows you to create a new Collection in the Workspace.

Name
CreateCollection

Request
POST:/api/v4/{workspace-slug}/collections

Secure
Inherited from Api.createCollection
- Defined in src/v4/generated/Api.ts:793

createDoc

createDoc(
    workspaceSlug: string,
    data: CreateDocBody,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<DocEntityWrapper>
Parameters
- workspaceSlug: string
- data: CreateDocBody
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<DocEntityWrapper>
Description
Create Doc allows you to create a new Doc in the Workspace.

Name
CreateDoc

Request
POST:/api/v4/{workspace-slug}/documents

Secure
Inherited from Api.createDoc
- Defined in src/v4/generated/Api.ts:1239

createEntityTemplate

createEntityTemplate(
    workspaceSlug: string,
    data: CreateEntityTemplateParams,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<EntityTemplateEntityWrapper>
Parameters
- workspaceSlug: string
- data: CreateEntityTemplateParams
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<EntityTemplateEntityWrapper>
Description
Create Entity Template creates a new Entity Template in your Shortcut Workspace.

Name
CreateEntityTemplate

Request
POST:/api/v4/{workspace-slug}/entity-templates

Secure
Inherited from Api.createEntityTemplate
- Defined in src/v4/generated/Api.ts:1539

createEpic

createEpic(
    workspaceSlug: string,
    data: CreateEpicParams,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<EpicEntityWrapper>
Parameters
- workspaceSlug: string
- data: CreateEpicParams
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<EpicEntityWrapper>
Description
Create Epic is used to create a new Epic in your Shortcut Workspace.

Name
CreateEpic

Request
POST:/api/v4/{workspace-slug}/epics

Secure
Inherited from Api.createEpic
- Defined in src/v4/generated/Api.ts:1837

createEpicComment

createEpicComment(
    workspaceSlug: string,
    epicPublicId: number,
    data: CreateEpicCommentParams,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<EpicCommentEntityWrapper>
Parameters
- workspaceSlug: string
- epicPublicId: number
- data: CreateEpicCommentParams
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<EpicCommentEntityWrapper>
Description
Create Epic Comment is used to add a new Comment to an Epic. To reply to an existing Comment, provide a parent_comment_id.

Name
CreateEpicComment

Request
POST:/api/v4/{workspace-slug}/epics/{epic-public-id}/comments

Secure
Inherited from Api.createEpicComment
- Defined in src/v4/generated/Api.ts:2299

createEpicHealth

createEpicHealth(
    workspaceSlug: string,
    epicPublicId: number,
    data: CreateEpicHealthParams,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<HealthEntityWrapper>
Parameters
- workspaceSlug: string
- epicPublicId: number
- data: CreateEpicHealthParams
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<HealthEntityWrapper>
Description
Creates a new Health update for the specified Epic.

Name
CreateEpicHealth

Request
POST:/api/v4/{workspace-slug}/epics/{epic-public-id}/epic-healths

Secure
Inherited from Api.createEpicHealth
- Defined in src/v4/generated/Api.ts:2443

createIteration

createIteration(
    workspaceSlug: string,
    data: CreateIterationParams,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<IterationEntityWrapper>
Parameters
- workspaceSlug: string
- data: CreateIterationParams
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<IterationEntityWrapper>
Description
Create Iteration is used to create a new Iteration in your Shortcut Workspace.

Name
CreateIteration

Request
POST:/api/v4/{workspace-slug}/iterations

Secure
Inherited from Api.createIteration
- Defined in src/v4/generated/Api.ts:3155

createLabel

createLabel(
    workspaceSlug: string,
    data: CreateLabelParams,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<LabelEntityWrapper>
Parameters
- workspaceSlug: string
- data: CreateLabelParams
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<LabelEntityWrapper>
Description
Create Label allows you to create a new Label in Shortcut.

Name
CreateLabel

Request
POST:/api/v4/{workspace-slug}/labels

Secure
Inherited from Api.createLabel
- Defined in src/v4/generated/Api.ts:3829

createLinkedFile

createLinkedFile(
    workspaceSlug: string,
    data: CreateLinkedFileParams,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<LinkedFileEntityWrapper>
Parameters
- workspaceSlug: string
- data: CreateLinkedFileParams
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<LinkedFileEntityWrapper>
Description
Create Linked File is used to add a new Linked File to your Shortcut Workspace.

Name
CreateLinkedFile

Request
POST:/api/v4/{workspace-slug}/linked-files

Secure
Inherited from Api.createLinkedFile
- Defined in src/v4/generated/Api.ts:4144

createObjective

createObjective(
    workspaceSlug: string,
    data: CreateObjectiveParams,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<ObjectiveEntityWrapper>
Parameters
- workspaceSlug: string
- data: CreateObjectiveParams
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<ObjectiveEntityWrapper>
Description
Create Objective is used to create a new Objective in your Shortcut Workspace.

Name
CreateObjective

Request
POST:/api/v4/{workspace-slug}/objectives

Secure
Inherited from Api.createObjective
- Defined in src/v4/generated/Api.ts:4706

createObjectiveHealth

createObjectiveHealth(
    workspaceSlug: string,
    objectivePublicId: number,
    data: CreateObjectiveHealthParams,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<HealthEntityWrapper>
Parameters
- workspaceSlug: string
- objectivePublicId: number
- data: CreateObjectiveHealthParams
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<HealthEntityWrapper>
Description
Creates a new Health update for the specified Objective.

Name
CreateObjectiveHealth

Request
POST:/api/v4/{workspace-slug}/objectives/{objective-public-id}/objective-healths

Secure
Inherited from Api.createObjectiveHealth
- Defined in src/v4/generated/Api.ts:5176

createProject

createProject(
    workspaceSlug: string,
    data: CreateProjectParams,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<ProjectEntityWrapper>
Parameters
- workspaceSlug: string
- data: CreateProjectParams
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<ProjectEntityWrapper>
Description
Create Project allows you to create a new Project in Shortcut. Projects are a deprecated feature.

Name
CreateProject

Request
POST:/api/v4/{workspace-slug}/projects

Deprecated
Secure
Inherited from Api.createProject
- Defined in src/v4/generated/Api.ts:5268

createStory

createStory(
    workspaceSlug: string,
    data: CreateStoryBody,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<StoryEntityWrapper>
Parameters
- workspaceSlug: string
- data: CreateStoryBody
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<StoryEntityWrapper>
Description
Create Story is used to add a new Story to your Shortcut Workspace.

Name
CreateStory

Request
POST:/api/v4/{workspace-slug}/stories

Secure
Inherited from Api.createStory
- Defined in src/v4/generated/Api.ts:5807

createStoryChecklistItem

createStoryChecklistItem(
    workspaceSlug: string,
    storyPublicId: number,
    data: CreateStoryChecklistItemBody,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<StoryChecklistItemEntityWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- data: CreateStoryChecklistItemBody
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<StoryChecklistItemEntityWrapper>
Description
Create Story Checklist Item is used to add a new Checklist Item to a Story.

Name
CreateStoryChecklistItem

Request
POST:/api/v4/{workspace-slug}/stories/{story-public-id}/checklist-items

Secure
Inherited from Api.createStoryChecklistItem
- Defined in src/v4/generated/Api.ts:6768

createStoryComment

createStoryComment(
    workspaceSlug: string,
    storyPublicId: number,
    data: CreateStoryCommentParams,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<StoryCommentEntityWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- data: CreateStoryCommentParams
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<StoryCommentEntityWrapper>
Description
Create Story is used to add a new Comment to a Story.

Name
CreateStoryComment

Request
POST:/api/v4/{workspace-slug}/stories/{story-public-id}/comments

Secure
Inherited from Api.createStoryComment
- Defined in src/v4/generated/Api.ts:6360

createStoryCommentReaction

createStoryCommentReaction(
    workspaceSlug: string,
    storyPublicId: number,
    commentPublicId: number,
    data: CreateStoryCommentReactionParams,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<StoryCommentReactionEntityWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- commentPublicId: number
- data: CreateStoryCommentReactionParams
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<StoryCommentReactionEntityWrapper>
Description
Create a Reaction to a Story Comment.

Name
CreateStoryCommentReaction

Request
POST:/api/v4/{workspace-slug}/stories/{story-public-id}/comments/{comment-public-id}/reactions

Secure
Inherited from Api.createStoryCommentReaction
- Defined in src/v4/generated/Api.ts:7215

createStoryLink

createStoryLink(
    workspaceSlug: string,
    data: CreateStoryLinkParams,
    params?: RequestParams,
): Promise<StoryLinkEntityWrapper>
Parameters
- workspaceSlug: string
- data: CreateStoryLinkParams
- params: RequestParams = {}
Returns Promise<StoryLinkEntityWrapper>
Description
Create Story Link is used to create a semantic relationship between two Stories. The subject Story acts on the object Story. For example, "Story A blocks Story B".

Name
CreateStoryLink

Request
POST:/api/v4/{workspace-slug}/story-links

Secure
Inherited from Api.createStoryLink
- Defined in src/v4/generated/Api.ts:7540

createTeam

createTeam(
    workspaceSlug: string,
    data: CreateTeamParams,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<TeamEntityWrapper>
Parameters
- workspaceSlug: string
- data: CreateTeamParams
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<TeamEntityWrapper>
Description
Creates a new Team in the Workspace.

Name
CreateTeam

Request
POST:/api/v4/{workspace-slug}/teams

Secure
Inherited from Api.createTeam
- Defined in src/v4/generated/Api.ts:7762

deleteCategory

deleteCategory(
    workspaceSlug: string,
    categoryPublicId: number,
    params?: RequestParams,
): Promise<void>
Parameters
- workspaceSlug: string
- categoryPublicId: number
- params: RequestParams = {}
Returns Promise<void>
Description
Delete Category removes a Category from the Workspace.

Name
DeleteCategory

Request
DELETE:/api/v4/{workspace-slug}/categories/{category-public-id}

Secure
Inherited from Api.deleteCategory
- Defined in src/v4/generated/Api.ts:646

deleteCustomField

deleteCustomField(
    workspaceSlug: string,
    customFieldPublicId: string,
    params?: RequestParams,
): Promise<void>
Parameters
- workspaceSlug: string
- customFieldPublicId: string
- params: RequestParams = {}
Returns Promise<void>
Description
Delete Custom Field removes a Custom Field from the Workspace.

Name
DeleteCustomField

Request
DELETE:/api/v4/{workspace-slug}/custom-fields/{custom-field-public-id}

Secure
Inherited from Api.deleteCustomField
- Defined in src/v4/generated/Api.ts:1092

deleteEntityTemplate

deleteEntityTemplate(
    workspaceSlug: string,
    entityTemplatePublicId: string,
    params?: RequestParams,
): Promise<void>
Parameters
- workspaceSlug: string
- entityTemplatePublicId: string
- params: RequestParams = {}
Returns Promise<void>
Description
Delete Entity Template removes an Entity Template from the Workspace.

Name
DeleteEntityTemplate

Request
DELETE:/api/v4/{workspace-slug}/entity-templates/{entity-template-public-id}

Secure
Inherited from Api.deleteEntityTemplate
- Defined in src/v4/generated/Api.ts:1668

deleteEpic

deleteEpic(
    workspaceSlug: string,
    epicPublicId: number,
    query?: { force?: boolean },
    params?: RequestParams,
): Promise<void>
Parameters
- workspaceSlug: string
- epicPublicId: number
- Optionalquery: { force?: boolean }
  - Optionalforce?: boolean
    Forces deletion of the Epic, overriding the check that it is archived.
- params: RequestParams = {}
Returns Promise<void>
Description
Delete Epic removes an Epic from the Workspace. The Epic must be archived unless force is set.

Name
DeleteEpic

Request
DELETE:/api/v4/{workspace-slug}/epics/{epic-public-id}

Secure
Inherited from Api.deleteEpic
- Defined in src/v4/generated/Api.ts:2008

deleteEpicComment

deleteEpicComment(
    workspaceSlug: string,
    epicPublicId: number,
    commentPublicId: number,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<void>
Parameters
- workspaceSlug: string
- epicPublicId: number
- commentPublicId: number
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<void>
Description
Delete a Comment from an Epic.

Name
DeleteEpicComment

Request
DELETE:/api/v4/{workspace-slug}/epics/{epic-public-id}/comments/{comment-public-id}

Secure
Inherited from Api.deleteEpicComment
- Defined in src/v4/generated/Api.ts:2654

deleteFile

deleteFile(
    workspaceSlug: string,
    filePublicId: number,
    params?: RequestParams,
): Promise<void>
Parameters
- workspaceSlug: string
- filePublicId: number
- params: RequestParams = {}
Returns Promise<void>
Description
Delete File removes a previously uploaded File from the Workspace.

Name
DeleteFile

Request
DELETE:/api/v4/{workspace-slug}/files/{file-public-id}

Secure
Inherited from Api.deleteFile
- Defined in src/v4/generated/Api.ts:2957

deleteIteration

deleteIteration(
    workspaceSlug: string,
    iterationPublicId: number,
    params?: RequestParams,
): Promise<void>
Parameters
- workspaceSlug: string
- iterationPublicId: number
- params: RequestParams = {}
Returns Promise<void>
Description
Delete Iteration removes an Iteration from the Workspace.

Name
DeleteIteration

Request
DELETE:/api/v4/{workspace-slug}/iterations/{iteration-public-id}

Secure
Inherited from Api.deleteIteration
- Defined in src/v4/generated/Api.ts:3359

deleteLabel

deleteLabel(
    workspaceSlug: string,
    labelPublicId: number,
    params?: RequestParams,
): Promise<void>
Parameters
- workspaceSlug: string
- labelPublicId: number
- params: RequestParams = {}
Returns Promise<void>
Description
Delete Label removes a Label from the Workspace.

Name
DeleteLabel

Request
DELETE:/api/v4/{workspace-slug}/labels/{label-public-id}

Secure
Inherited from Api.deleteLabel
- Defined in src/v4/generated/Api.ts:3958

deleteLinkedFile

deleteLinkedFile(
    workspaceSlug: string,
    linkedFilePublicId: number,
    params?: RequestParams,
): Promise<void>
Parameters
- workspaceSlug: string
- linkedFilePublicId: number
- params: RequestParams = {}
Returns Promise<void>
Description
Delete Linked File removes a Linked File from the Workspace.

Name
DeleteLinkedFile

Request
DELETE:/api/v4/{workspace-slug}/linked-files/{linked-file-public-id}

Secure
Inherited from Api.deleteLinkedFile
- Defined in src/v4/generated/Api.ts:4273

deleteObjective

deleteObjective(
    workspaceSlug: string,
    objectivePublicId: number,
    params?: RequestParams,
): Promise<void>
Parameters
- workspaceSlug: string
- objectivePublicId: number
- params: RequestParams = {}
Returns Promise<void>
Description
Delete Objective removes an Objective from the Workspace.

Name
DeleteObjective

Request
DELETE:/api/v4/{workspace-slug}/objectives/{objective-public-id}

Secure
Inherited from Api.deleteObjective
- Defined in src/v4/generated/Api.ts:4872

deleteProject

deleteProject(
    workspaceSlug: string,
    projectPublicId: number,
    params?: RequestParams,
): Promise<void>
Parameters
- workspaceSlug: string
- projectPublicId: number
- params: RequestParams = {}
Returns Promise<void>
Description
Delete Project can be used to delete any Project. Projects are a deprecated feature.

Name
DeleteProject

Request
DELETE:/api/v4/{workspace-slug}/projects/{project-public-id}

Deprecated
Secure
Inherited from Api.deleteProject
- Defined in src/v4/generated/Api.ts:5295

deleteStory

deleteStory(
    workspaceSlug: string,
    storyPublicId: number,
    query?: { force?: boolean },
    params?: RequestParams,
): Promise<void>
Parameters
- workspaceSlug: string
- storyPublicId: number
- Optionalquery: { force?: boolean }
  - Optionalforce?: boolean
    Forces deletion of the Story, overriding the check that it is archived.
- params: RequestParams = {}
Returns Promise<void>
Description
Delete Story can be used to delete a Story. The Story must be archived unless force is set.

Name
DeleteStory

Request
DELETE:/api/v4/{workspace-slug}/stories/{story-public-id}

Secure
Inherited from Api.deleteStory
- Defined in src/v4/generated/Api.ts:6014

deleteStoryChecklistItem

deleteStoryChecklistItem(
    workspaceSlug: string,
    storyPublicId: number,
    checklistItemPublicId: number,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<void>
Parameters
- workspaceSlug: string
- storyPublicId: number
- checklistItemPublicId: number
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<void>
Description
Delete a Checklist Item from a Story.

Name
DeleteStoryChecklistItem

Request
DELETE:/api/v4/{workspace-slug}/stories/{story-public-id}/checklist-items/{checklist-item-public-id}

Secure
Inherited from Api.deleteStoryChecklistItem
- Defined in src/v4/generated/Api.ts:7243

deleteStoryComment

deleteStoryComment(
    workspaceSlug: string,
    storyPublicId: number,
    commentPublicId: number,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<void>
Parameters
- workspaceSlug: string
- storyPublicId: number
- commentPublicId: number
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<void>
Description
Delete a Comment from a Story.

Name
DeleteStoryComment

Request
DELETE:/api/v4/{workspace-slug}/stories/{story-public-id}/comments/{comment-public-id}

Secure
Inherited from Api.deleteStoryComment
- Defined in src/v4/generated/Api.ts:7057

deleteStoryCommentReaction

deleteStoryCommentReaction(
    workspaceSlug: string,
    storyPublicId: number,
    commentPublicId: number,
    reactionPublicId: string,
    params?: RequestParams,
): Promise<void>
Parameters
- workspaceSlug: string
- storyPublicId: number
- commentPublicId: number
- reactionPublicId: string
- params: RequestParams = {}
Returns Promise<void>
Description
Delete a Reaction from a Story Comment.

Name
DeleteStoryCommentReaction

Request
DELETE:/api/v4/{workspace-slug}/stories/{story-public-id}/comments/{comment-public-id}/reactions/{reaction-public-id}

Secure
Inherited from Api.deleteStoryCommentReaction
- Defined in src/v4/generated/Api.ts:7441

deleteStoryLink

deleteStoryLink(
    workspaceSlug: string,
    storyLinkPublicId: number,
    params?: RequestParams,
): Promise<void>
Parameters
- workspaceSlug: string
- storyLinkPublicId: number
- params: RequestParams = {}
Returns Promise<void>
Description
Delete Story Link removes the relationship between the Stories for the given Story Link.

Name
DeleteStoryLink

Request
DELETE:/api/v4/{workspace-slug}/story-links/{story-link-public-id}

Secure
Inherited from Api.deleteStoryLink
- Defined in src/v4/generated/Api.ts:7664

deleteWorkspaceToken

deleteWorkspaceToken(
    workspaceSlug: string,
    tokenPublicId: string,
    params?: RequestParams,
): Promise<void>
Parameters
- workspaceSlug: string
- tokenPublicId: string
- params: RequestParams = {}
Returns Promise<void>
Description
Delete Workspace Token disables an API Token in the Workspace. Requires admin role.

Name
DeleteWorkspaceToken

Request
DELETE:/api/v4/{workspace-slug}/admin/tokens/{token-public-id}

Secure
Inherited from Api.deleteWorkspaceToken
- Defined in src/v4/generated/Api.ts:320

`Protected`encodeQueryParam

encodeQueryParam(key: string, value: any): string
Parameters
- key: string
- value: any
Returns string
Inherited from Api.encodeQueryParam
- Defined in src/v4/generated/http-client.ts:104

favoriteCollection

favoriteCollection(
    workspaceSlug: string,
    collectionPublicId: string,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<CollectionEntityWrapper>
Parameters
- workspaceSlug: string
- collectionPublicId: string
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<CollectionEntityWrapper>
Description
Favorite Collection marks the Collection as a favorite of the current Member, and returns the updated Collection.

Name
FavoriteCollection

Request
PUT:/api/v4/{workspace-slug}/collections/{collection-public-id}/favorite

Secure
Inherited from Api.favoriteCollection
- Defined in src/v4/generated/Api.ts:843

getBranch

getBranch(
    workspaceSlug: string,
    branchPublicId: number,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<BranchEntityWrapper>
Parameters
- workspaceSlug: string
- branchPublicId: number
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<BranchEntityWrapper>
Description
Get Branch returns information about a chosen Branch.

Name
GetBranch

Request
GET:/api/v4/{workspace-slug}/branches/{branch-public-id}

Secure
Inherited from Api.getBranch
- Defined in src/v4/generated/Api.ts:377

getCategory

getCategory(
    workspaceSlug: string,
    categoryPublicId: number,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<CategoryEntityWrapper>
Parameters
- workspaceSlug: string
- categoryPublicId: number
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<CategoryEntityWrapper>
Description
Get Category returns information about a chosen Category.

Name
GetCategory

Request
GET:/api/v4/{workspace-slug}/categories/{category-public-id}

Secure
Inherited from Api.getCategory
- Defined in src/v4/generated/Api.ts:665

getCollection

getCollection(
    workspaceSlug: string,
    collectionPublicId: string,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<CollectionEntityWrapper>
Parameters
- workspaceSlug: string
- collectionPublicId: string
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<CollectionEntityWrapper>
Description
Get Collection returns information about a chosen Collection.

Name
GetCollection

Request
GET:/api/v4/{workspace-slug}/collections/{collection-public-id}

Secure
Inherited from Api.getCollection
- Defined in src/v4/generated/Api.ts:819

getCommit

getCommit(
    workspaceSlug: string,
    commitPublicId: number,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<CommitEntityWrapper>
Parameters
- workspaceSlug: string
- commitPublicId: number
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<CommitEntityWrapper>
Description
Get Commit returns information about a chosen Commit.

Name
GetCommit

Request
GET:/api/v4/{workspace-slug}/commits/{commit-public-id}

Secure
Inherited from Api.getCommit
- Defined in src/v4/generated/Api.ts:929

getCurrentIterations

getCurrentIterations(
    workspaceSlug: string,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "updated_at" | "start_date";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<CurrentIterationsOutput>
Parameters
- workspaceSlug: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "updated_at" | "start_date";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at" | "start_date"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<CurrentIterationsOutput>
Description
Returns all currently started iterations for the authenticated user based on their team memberships. The 'current' iterations are determined by finding started iterations associated with teams the user belongs to. If multiple iterations match, all are returned sorted by start date (ascending), then end date (ascending), then ID (ascending).

Name
GetCurrentIterations

Request
GET:/api/v4/{workspace-slug}/iterations/current

Secure
Inherited from Api.getCurrentIterations
- Defined in src/v4/generated/Api.ts:3321

getCustomField

getCustomField(
    workspaceSlug: string,
    customFieldPublicId: string,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<CustomFieldEntityWrapper>
Parameters
- workspaceSlug: string
- customFieldPublicId: string
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<CustomFieldEntityWrapper>
Description
Get Custom Field returns information about a chosen Custom Field.

Name
GetCustomField

Request
GET:/api/v4/{workspace-slug}/custom-fields/{custom-field-public-id}

Secure
Inherited from Api.getCustomField
- Defined in src/v4/generated/Api.ts:1111

getDoc

getDoc(
    workspaceSlug: string,
    docPublicId: string,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<DocEntityWrapper>
Parameters
- workspaceSlug: string
- docPublicId: string
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<DocEntityWrapper>
Description
Get Doc returns information about a chosen Doc. Pass content_format=markdown (default) or content_format=html to include content in the response.

Name
GetDoc

Request
GET:/api/v4/{workspace-slug}/documents/{doc-public-id}

Secure
Inherited from Api.getDoc
- Defined in src/v4/generated/Api.ts:1349

getEntityTemplate

getEntityTemplate(
    workspaceSlug: string,
    entityTemplatePublicId: string,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<EntityTemplateEntityWrapper>
Parameters
- workspaceSlug: string
- entityTemplatePublicId: string
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<EntityTemplateEntityWrapper>
Description
Get Entity Template returns information about a given Entity Template.

Name
GetEntityTemplate

Request
GET:/api/v4/{workspace-slug}/entity-templates/{entity-template-public-id}

Secure
Inherited from Api.getEntityTemplate
- Defined in src/v4/generated/Api.ts:1687

getEpic

getEpic(
    workspaceSlug: string,
    epicPublicId: number,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<EpicEntityWrapper>
Parameters
- workspaceSlug: string
- epicPublicId: number
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<EpicEntityWrapper>
Description
Get Epic returns information about a chosen Epic.

Name
GetEpic

Request
GET:/api/v4/{workspace-slug}/epics/{epic-public-id}

Secure
Inherited from Api.getEpic
- Defined in src/v4/generated/Api.ts:2032

getEpicComment

getEpicComment(
    workspaceSlug: string,
    epicPublicId: number,
    commentPublicId: number,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<EpicCommentEntityWrapper>
Parameters
- workspaceSlug: string
- epicPublicId: number
- commentPublicId: number
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<EpicCommentEntityWrapper>
Description
Get Epic Comment returns information about a chosen Epic Comment.

Name
GetEpicComment

Request
GET:/api/v4/{workspace-slug}/epics/{epic-public-id}/comments/{comment-public-id}

Secure
Inherited from Api.getEpicComment
- Defined in src/v4/generated/Api.ts:2679

getEpicHealth

getEpicHealth(
    workspaceSlug: string,
    epicPublicId: number,
    epicHealthPublicId: string,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<HealthEntityWrapper>
Parameters
- workspaceSlug: string
- epicPublicId: number
- epicHealthPublicId: string
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<HealthEntityWrapper>
Description
Returns a Health for the specified Epic.

Name
GetEpicHealth

Request
GET:/api/v4/{workspace-slug}/epics/{epic-public-id}/epic-healths/{epic-health-public-id}

Secure
Inherited from Api.getEpicHealth
- Defined in src/v4/generated/Api.ts:2732

getEpicStats

getEpicStats(
    workspaceSlug: string,
    epicPublicId: number,
    params?: RequestParams,
): Promise<EpicStatsWrapper>
Parameters
- workspaceSlug: string
- epicPublicId: number
- params: RequestParams = {}
Returns Promise<EpicStatsWrapper>
Description
Get Epic Stats returns calculated stats for a chosen Epic. Stats are served from this dedicated sub-endpoint (rather than the Epic response itself) to avoid the performance impact of computing them on bulk list requests.

Name
GetEpicStats

Request
GET:/api/v4/{workspace-slug}/epics/{epic-public-id}/stats

Secure
Inherited from Api.getEpicStats
- Defined in src/v4/generated/Api.ts:2083

getEpicWorkflow

getEpicWorkflow(
    workspaceSlug: string,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<EpicWorkflowEntityWrapper>
Parameters
- workspaceSlug: string
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<EpicWorkflowEntityWrapper>
Description
Returns the Epic Workflow configuration for the Workspace.

Name
GetEpicWorkflow

Request
GET:/api/v4/{workspace-slug}/epic-workflow

Secure
Inherited from Api.getEpicWorkflow
- Defined in src/v4/generated/Api.ts:1738

getFile

getFile(
    workspaceSlug: string,
    filePublicId: number,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<FileEntityWrapper>
Parameters
- workspaceSlug: string
- filePublicId: number
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<FileEntityWrapper>
Description
Get File returns information about the chosen File.

Name
GetFile

Request
GET:/api/v4/{workspace-slug}/files/{file-public-id}

Secure
Inherited from Api.getFile
- Defined in src/v4/generated/Api.ts:2976

getIteration

getIteration(
    workspaceSlug: string,
    iterationPublicId: number,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<IterationEntityWrapper>
Parameters
- workspaceSlug: string
- iterationPublicId: number
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<IterationEntityWrapper>
Description
Get Iteration returns information about a chosen Iteration.

Name
GetIteration

Request
GET:/api/v4/{workspace-slug}/iterations/{iteration-public-id}

Secure
Inherited from Api.getIteration
- Defined in src/v4/generated/Api.ts:3378

getKeyResult

getKeyResult(
    workspaceSlug: string,
    keyResultPublicId: string,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<KeyResultEntityWrapper>
Parameters
- workspaceSlug: string
- keyResultPublicId: string
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<KeyResultEntityWrapper>
Description
Returns the specified Key Result.

Name
GetKeyResult

Request
GET:/api/v4/{workspace-slug}/key-results/{key-result-public-id}

Secure
Inherited from Api.getKeyResult
- Defined in src/v4/generated/Api.ts:3740

getLabel

getLabel(
    workspaceSlug: string,
    labelPublicId: number,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<LabelEntityWrapper>
Parameters
- workspaceSlug: string
- labelPublicId: number
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<LabelEntityWrapper>
Description
Get Label returns information about a chosen Label.

Name
GetLabel

Request
GET:/api/v4/{workspace-slug}/labels/{label-public-id}

Secure
Inherited from Api.getLabel
- Defined in src/v4/generated/Api.ts:3977

getLinkedFile

getLinkedFile(
    workspaceSlug: string,
    linkedFilePublicId: number,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<LinkedFileEntityWrapper>
Parameters
- workspaceSlug: string
- linkedFilePublicId: number
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<LinkedFileEntityWrapper>
Description
Get Linked File returns information about the chosen Linked File.

Name
GetLinkedFile

Request
GET:/api/v4/{workspace-slug}/linked-files/{linked-file-public-id}

Secure
Inherited from Api.getLinkedFile
- Defined in src/v4/generated/Api.ts:4292

getMember

getMember(
    workspaceSlug: string,
    memberPublicId: string,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<MemberEntityWrapper>
Parameters
- workspaceSlug: string
- memberPublicId: string
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<MemberEntityWrapper>
Description
Get Member returns information about a Member of the Workspace.

Name
GetMember

Request
GET:/api/v4/{workspace-slug}/members/{member-public-id}

Secure
Inherited from Api.getMember
- Defined in src/v4/generated/Api.ts:4539

getMultipleStoriesHistory

getMultipleStoriesHistory(
    workspaceSlug: string,
    query?: {
        cursor?: string;
        fields?: string;
        ids?: string;
        limit?: number;
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StoryHistoryResponseWrapper>
Parameters
- workspaceSlug: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      ids?: string;
      limit?: number;
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Filter history to specific attributes (e.g., workflow_state,epic).
  - Optionalids?: string
    Comma-separated Story IDs (max 100).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_dir?: "desc" | "asc"
    Sort direction by change instant: asc (default, oldest first) or desc (newest first). Entries at the same instant keep the same deterministic tie-break order in both directions.
- params: RequestParams = {}
Returns Promise<StoryHistoryResponseWrapper>
Description
Returns history of changes for multiple Stories in chronological order (oldest first by default; newest first with order_dir=desc), across all attributes, with a deterministic tie-break for changes at the same instant. Ordering is stable across pages. Requires ?ids= parameter. Supports cursor-based pagination. History is currently tracked for these attributes: archived, completed, custom_field_values, deadline, epic, estimate, iterations, labels, owners, project, started, story_type, team, workflow_state. Changes to other attributes are not included yet but will be added.

Name
GetMultipleStoriesHistory

Request
GET:/api/v4/{workspace-slug}/stories/history

Secure
Inherited from Api.getMultipleStoriesHistory
- Defined in src/v4/generated/Api.ts:5978

getObjective

getObjective(
    workspaceSlug: string,
    objectivePublicId: number,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<ObjectiveEntityWrapper>
Parameters
- workspaceSlug: string
- objectivePublicId: number
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<ObjectiveEntityWrapper>
Description
Get Objective returns information about a chosen Objective.

Name
GetObjective

Request
GET:/api/v4/{workspace-slug}/objectives/{objective-public-id}

Secure
Inherited from Api.getObjective
- Defined in src/v4/generated/Api.ts:4891

getObjectiveHealth

getObjectiveHealth(
    workspaceSlug: string,
    objectivePublicId: number,
    objectiveHealthPublicId: string,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<HealthEntityWrapper>
Parameters
- workspaceSlug: string
- objectivePublicId: number
- objectiveHealthPublicId: string
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<HealthEntityWrapper>
Description
Returns a Health for the specified Objective.

Name
GetObjectiveHealth

Request
GET:/api/v4/{workspace-slug}/objectives/{objective-public-id}/objective-healths/{objective-health-public-id}

Secure
Inherited from Api.getObjectiveHealth
- Defined in src/v4/generated/Api.ts:5203

getProject

getProject(
    workspaceSlug: string,
    projectPublicId: number,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<ProjectEntityWrapper>
Parameters
- workspaceSlug: string
- projectPublicId: number
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<ProjectEntityWrapper>
Description
Get Project returns information about the chosen Project. Projects are a deprecated feature.

Name
GetProject

Request
GET:/api/v4/{workspace-slug}/projects/{project-public-id}

Deprecated
Secure
Inherited from Api.getProject
- Defined in src/v4/generated/Api.ts:5315

getPullRequest

getPullRequest(
    workspaceSlug: string,
    pullRequestPublicId: number,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<PullRequestEntityWrapper>
Parameters
- workspaceSlug: string
- pullRequestPublicId: number
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<PullRequestEntityWrapper>
Description
Get Pull Request returns information about a chosen Pull Request.

Name
GetPullRequest

Request
GET:/api/v4/{workspace-slug}/pull-requests/{pull-request-public-id}

Secure
Inherited from Api.getPullRequest
- Defined in src/v4/generated/Api.ts:5485

getRepository

getRepository(
    workspaceSlug: string,
    repositoryPublicId: number,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<RepositoryEntityWrapper>
Parameters
- workspaceSlug: string
- repositoryPublicId: number
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<RepositoryEntityWrapper>
Description
Get Repository returns information about a connected Repository.

Name
GetRepository

Request
GET:/api/v4/{workspace-slug}/repositories/{repository-public-id}

Secure
Inherited from Api.getRepository
- Defined in src/v4/generated/Api.ts:5586

getSchema

getSchema(
schemaName: string,
params?: RequestParams,
): Promise<Record<string, any>>
Parameters
- schemaName: string
- params: RequestParams = {}
Returns Promise<Record<string, any>>
Description
Gets the json-schema for a route.

Name
GetSchema

Request
GET:/api/v4/schemas/{schema-name}

Secure
Inherited from Api.getSchema
- Defined in src/v4/generated/Api.ts:267

getStory

getStory(
    workspaceSlug: string,
    storyPublicId: number,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<StoryEntityWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<StoryEntityWrapper>
Description
Get Story returns information about a chosen Story.

Name
GetStory

Request
GET:/api/v4/{workspace-slug}/stories/{story-public-id}

Secure
Inherited from Api.getStory
- Defined in src/v4/generated/Api.ts:6038

getStoryChecklistItem

getStoryChecklistItem(
    workspaceSlug: string,
    storyPublicId: number,
    checklistItemPublicId: number,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<StoryChecklistItemEntityWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- checklistItemPublicId: number
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<StoryChecklistItemEntityWrapper>
Description
Get Story Checklist Item returns information about a chosen Checklist Item for a Story.

Name
GetStoryChecklistItem

Request
GET:/api/v4/{workspace-slug}/stories/{story-public-id}/checklist-items/{checklist-item-public-id}

Secure
Inherited from Api.getStoryChecklistItem
- Defined in src/v4/generated/Api.ts:7268

getStoryComment

getStoryComment(
    workspaceSlug: string,
    storyPublicId: number,
    commentPublicId: number,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<StoryCommentEntityWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- commentPublicId: number
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<StoryCommentEntityWrapper>
Description
Get Story Comment returns information about a chosen Story Comment.

Name
GetStoryComment

Request
GET:/api/v4/{workspace-slug}/stories/{story-public-id}/comments/{comment-public-id}

Secure
Inherited from Api.getStoryComment
- Defined in src/v4/generated/Api.ts:7082

getStoryHistory

getStoryHistory(
    workspaceSlug: string,
    storyPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        limit?: number;
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StoryHistoryResponseWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- Optionalquery: { cursor?: string; fields?: string; limit?: number; order_dir?: "desc" | "asc" }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Filter history to specific attributes (e.g., workflow_state,epic).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_dir?: "desc" | "asc"
    Sort direction by change instant: asc (default, oldest first) or desc (newest first). Entries at the same instant keep the same deterministic tie-break order in both directions.
- params: RequestParams = {}
Returns Promise<StoryHistoryResponseWrapper>
Description
Returns history of changes for a Story in chronological order (oldest first by default; newest first with order_dir=desc), across all attributes, with a deterministic tie-break for changes at the same instant. Ordering is stable across pages. Supports cursor-based pagination and optional field filtering. History is currently tracked for these attributes: archived, completed, custom_field_values, deadline, epic, estimate, iterations, labels, owners, project, started, story_type, team, workflow_state. Changes to other attributes are not included yet but will be added.

Name
GetStoryHistory

Request
GET:/api/v4/{workspace-slug}/stories/{story-public-id}/history

Secure
Inherited from Api.getStoryHistory
- Defined in src/v4/generated/Api.ts:6245

getStoryLink

getStoryLink(
    workspaceSlug: string,
    storyLinkPublicId: number,
    params?: RequestParams,
): Promise<StoryLinkEntityWrapper>
Parameters
- workspaceSlug: string
- storyLinkPublicId: number
- params: RequestParams = {}
Returns Promise<StoryLinkEntityWrapper>
Description
Get Story Link returns information about a chosen Story Link.

Name
GetStoryLink

Request
GET:/api/v4/{workspace-slug}/story-links/{story-link-public-id}

Secure
Inherited from Api.getStoryLink
- Defined in src/v4/generated/Api.ts:7683

getTeam

getTeam(
    workspaceSlug: string,
    teamPublicId: string,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<TeamEntityWrapper>
Parameters
- workspaceSlug: string
- teamPublicId: string
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<TeamEntityWrapper>
Description
Returns the specified Team.

Name
GetTeam

Request
GET:/api/v4/{workspace-slug}/teams/{team-public-id}

Secure
Inherited from Api.getTeam
- Defined in src/v4/generated/Api.ts:7870

getWhoami

getWhoami(params?: RequestParams): Promise<WhoamiEntityWrapper>
Parameters
- params: RequestParams = {}
Returns Promise<WhoamiEntityWrapper>
Description
Returns details about the currently-authenticated member and token authorization.

Name
GetWhoami

Request
GET:/api/v4/whoami

Secure
Inherited from Api.getWhoami
- Defined in src/v4/generated/Api.ts:252

getWorkflow

getWorkflow(
    workspaceSlug: string,
    workflowPublicId: number,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<WorkflowEntityWrapper>
Parameters
- workspaceSlug: string
- workflowPublicId: number
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<WorkflowEntityWrapper>
Description
Returns the specified Workflow.

Name
GetWorkflow

Request
GET:/api/v4/{workspace-slug}/workflows/{workflow-public-id}

Secure
Inherited from Api.getWorkflow
- Defined in src/v4/generated/Api.ts:8177

getWorkflowState

getWorkflowState(
    workspaceSlug: string,
    workflowStatePublicId: number,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<WorkflowStateEntityWrapper>
Parameters
- workspaceSlug: string
- workflowStatePublicId: number
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<WorkflowStateEntityWrapper>
Description
Returns the specified Workflow State.

Name
GetWorkflowState

Request
GET:/api/v4/{workspace-slug}/workflow-states/{workflow-state-public-id}

Secure
Inherited from Api.getWorkflowState
- Defined in src/v4/generated/Api.ts:8076

listBranches

listBranches(
    workspaceSlug: string,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_deleted" | "include_deleted";
        limit?: number;
        order_by?: "name" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<BranchEntityListWrapper>
Parameters
- workspaceSlug: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_deleted" | "include_deleted";
      limit?: number;
      order_by?: "name" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_deleted" | "include_deleted"
    Filter options (default: :exclude_deleted).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<BranchEntityListWrapper>
Description
List Branches returns a paginated list of all Branches in the Workspace that have either been associated with a Story, or used in a Pull Request that was associated with a Story.

Name
ListBranches

Request
GET:/api/v4/{workspace-slug}/branches

Secure
Inherited from Api.listBranches
- Defined in src/v4/generated/Api.ts:339

listBranchPullRequests

listBranchPullRequests(
    workspaceSlug: string,
    branchPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_closed" | "include_closed";
        limit?: number;
        order_by?: "created_at" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<BranchPullRequestEntityListWrapper>
Parameters
- workspaceSlug: string
- branchPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_closed" | "include_closed";
      limit?: number;
      order_by?: "created_at" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_closed" | "include_closed"
    Filter options (default: :include_closed).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "created_at" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<BranchPullRequestEntityListWrapper>
Description
List Branch Pull Requests returns a paginated list of all Pull Requests associated with a Branch in the Workspace.

Name
ListBranchPullRequests

Request
GET:/api/v4/{workspace-slug}/branches/{branch-public-id}/pull-requests

Secure
Inherited from Api.listBranchPullRequests
- Defined in src/v4/generated/Api.ts:440

listBranchStories

listBranchStories(
    workspaceSlug: string,
    branchPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "created_at" | "updated_at" | "position";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<BranchStoryEntityListWrapper>
Parameters
- workspaceSlug: string
- branchPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "created_at" | "updated_at" | "position";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "created_at" | "updated_at" | "position"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<BranchStoryEntityListWrapper>
Description
List Branch Stories returns a paginated list of all Stories associated with a Branch in the Workspace.

Name
ListBranchStories

Request
GET:/api/v4/{workspace-slug}/branches/{branch-public-id}/stories

Secure
Inherited from Api.listBranchStories
- Defined in src/v4/generated/Api.ts:401

listCategories(
    workspaceSlug: string,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "name" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<CategoryEntityListWrapper>
Parameters
- workspaceSlug: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "name" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<CategoryEntityListWrapper>
Description
List Categories returns a paginated list of all Categories in the Workspace.

Name
ListCategories

Request
GET:/api/v4/{workspace-slug}/categories

Secure
Inherited from Api.listCategories
- Defined in src/v4/generated/Api.ts:479

listCategoryObjectives

listCategoryObjectives(
    workspaceSlug: string,
    categoryPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<CategoryObjectiveEntityListWrapper>
Parameters
- workspaceSlug: string
- categoryPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<CategoryObjectiveEntityListWrapper>
Description
List Category Objectives returns a paginated list of all Objectives associated with a Category in the Workspace.

Name
ListCategoryObjectives

Request
GET:/api/v4/{workspace-slug}/categories/{category-public-id}/objectives

Secure
Inherited from Api.listCategoryObjectives
- Defined in src/v4/generated/Api.ts:716

listCollections

listCollections(
    workspaceSlug: string,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived" | "favorited";
        limit?: number;
        order_by?: "name" | "created_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<CollectionEntityListWrapper>
Parameters
- workspaceSlug: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived" | "favorited";
      limit?: number;
      order_by?: "name" | "created_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived" | "favorited"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "created_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<CollectionEntityListWrapper>
Description
List Collections returns a paginated list of all Collections in the Workspace.

Name
ListCollections

Request
GET:/api/v4/{workspace-slug}/collections

Secure
Inherited from Api.listCollections
- Defined in src/v4/generated/Api.ts:755

listCommits

listCommits(
    workspaceSlug: string,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<CommitEntityListWrapper>
Parameters
- workspaceSlug: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<CommitEntityListWrapper>
Description
List Commits returns a paginated list of all Commits in the Workspace that have been associated with Stories.

Name
ListCommits

Request
GET:/api/v4/{workspace-slug}/commits

Secure
Inherited from Api.listCommits
- Defined in src/v4/generated/Api.ts:891

listCommitStories

listCommitStories(
    workspaceSlug: string,
    commitPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "created_at" | "updated_at" | "position";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<CommitStoryEntityListWrapper>
Parameters
- workspaceSlug: string
- commitPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "created_at" | "updated_at" | "position";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "created_at" | "updated_at" | "position"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<CommitStoryEntityListWrapper>
Description
List Commit Stories returns a paginated list of all Stories associated with a Commit in the Workspace.

Name
ListCommitStories

Request
GET:/api/v4/{workspace-slug}/commits/{commit-public-id}/stories

Secure
Inherited from Api.listCommitStories
- Defined in src/v4/generated/Api.ts:953

listCustomFields

listCustomFields(
    workspaceSlug: string,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "name" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<CustomFieldEntityListWrapper>
Parameters
- workspaceSlug: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "name" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<CustomFieldEntityListWrapper>
Description
List Custom Fields returns a paginated list of all Custom Fields in the Workspace.

Name
ListCustomFields

Request
GET:/api/v4/{workspace-slug}/custom-fields

Secure
Inherited from Api.listCustomFields
- Defined in src/v4/generated/Api.ts:992

listCustomFieldStories

listCustomFieldStories(
    workspaceSlug: string,
    customFieldPublicId: string,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "created_at" | "updated_at" | "position";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<CustomFieldStoryEntityListWrapper>
Parameters
- workspaceSlug: string
- customFieldPublicId: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "created_at" | "updated_at" | "position";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "created_at" | "updated_at" | "position"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<CustomFieldStoryEntityListWrapper>
Description
Returns a paginated list of all Stories that have a value set for the specified Custom Field.

Name
ListCustomFieldStories

Request
GET:/api/v4/{workspace-slug}/custom-fields/{custom-field-public-id}/stories

Secure
Inherited from Api.listCustomFieldStories
- Defined in src/v4/generated/Api.ts:1162

listDocCollections

listDocCollections(
    workspaceSlug: string,
    docPublicId: string,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived" | "favorited";
        limit?: number;
        order_by?: "name" | "created_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<DocCollectionEntityListWrapper>
Parameters
- workspaceSlug: string
- docPublicId: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived" | "favorited";
      limit?: number;
      order_by?: "name" | "created_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived" | "favorited"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "created_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<DocCollectionEntityListWrapper>
Description
List Doc Collections returns a paginated list of the Collections the Doc belongs to.

Name
ListDocCollections

Request
GET:/api/v4/{workspace-slug}/documents/{doc-public-id}/collections

Secure
Inherited from Api.listDocCollections
- Defined in src/v4/generated/Api.ts:1414

listDocFollowers

listDocFollowers(
    workspaceSlug: string,
    docPublicId: string,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_disabled" | "include_disabled";
        limit?: number;
        order_by?: "name";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<DocFollowerEntityListWrapper>
Parameters
- workspaceSlug: string
- docPublicId: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_disabled" | "include_disabled";
      limit?: number;
      order_by?: "name";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_disabled" | "include_disabled"
    Filter options (default: :exclude_disabled).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<DocFollowerEntityListWrapper>
Description
List Doc Followers returns a paginated list of all Members following a Doc in the Workspace.

Name
ListDocFollowers

Request
GET:/api/v4/{workspace-slug}/documents/{doc-public-id}/followers

Secure
Inherited from Api.listDocFollowers
- Defined in src/v4/generated/Api.ts:1373

listDocs

listDocs(
    workspaceSlug: string,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "created_at" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<DocEntityListWrapper>
Parameters
- workspaceSlug: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "created_at" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "created_at" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<DocEntityListWrapper>
Description
List Docs returns a paginated list of all accessible Docs in the Workspace.

Name
ListDocs

Request
GET:/api/v4/{workspace-slug}/documents

Secure
Inherited from Api.listDocs
- Defined in src/v4/generated/Api.ts:1201

listEntityTemplates

listEntityTemplates(
    workspaceSlug: string,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<EntityTemplateEntityListWrapper>
Parameters
- workspaceSlug: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<EntityTemplateEntityListWrapper>
Description
List Entity Templates returns a paginated list of all Entity Templates in the Workspace.

Name
ListEntityTemplates

Request
GET:/api/v4/{workspace-slug}/entity-templates

Secure
Inherited from Api.listEntityTemplates
- Defined in src/v4/generated/Api.ts:1501

listEpicCommentComments

listEpicCommentComments(
    workspaceSlug: string,
    epicPublicId: number,
    commentPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "created_at" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<EpicCommentCommentEntityListWrapper>
Parameters
- workspaceSlug: string
- epicPublicId: number
- commentPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "created_at" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "created_at" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<EpicCommentCommentEntityListWrapper>
Description
List Epic Comment Comments returns a paginated list of all threaded reply Comments for an Epic Comment in the Workspace.

Name
ListEpicCommentComments

Request
GET:/api/v4/{workspace-slug}/epics/{epic-public-id}/comments/{comment-public-id}/comments

Secure
Inherited from Api.listEpicCommentComments
- Defined in src/v4/generated/Api.ts:2757

listEpicCommentMentionedMembers

listEpicCommentMentionedMembers(
    workspaceSlug: string,
    epicPublicId: number,
    commentPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_disabled" | "include_disabled";
        limit?: number;
        order_by?: "name";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<EpicCommentMentionedMemberEntityListWrapper>
Parameters
- workspaceSlug: string
- epicPublicId: number
- commentPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_disabled" | "include_disabled";
      limit?: number;
      order_by?: "name";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_disabled" | "include_disabled"
    Filter options (default: :exclude_disabled).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<EpicCommentMentionedMemberEntityListWrapper>
Description
List Epic Comment Mentioned Members returns a paginated list of all Members mentioned in an Epic Comment in the Workspace.

Name
ListEpicCommentMentionedMembers

Request
GET:/api/v4/{workspace-slug}/epics/{epic-public-id}/comments/{comment-public-id}/mentioned-members

Secure
Inherited from Api.listEpicCommentMentionedMembers
- Defined in src/v4/generated/Api.ts:2837

listEpicCommentMentionedTeams

listEpicCommentMentionedTeams(
    workspaceSlug: string,
    epicPublicId: number,
    commentPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "name" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<EpicCommentMentionedTeamEntityListWrapper>
Parameters
- workspaceSlug: string
- epicPublicId: number
- commentPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "name" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<EpicCommentMentionedTeamEntityListWrapper>
Description
List Epic Comment Mentioned Teams returns a paginated list of all Teams mentioned in an Epic Comment in the Workspace.

Name
ListEpicCommentMentionedTeams

Request
GET:/api/v4/{workspace-slug}/epics/{epic-public-id}/comments/{comment-public-id}/mentioned-teams

Secure
Inherited from Api.listEpicCommentMentionedTeams
- Defined in src/v4/generated/Api.ts:2797

listEpicComments

listEpicComments(
    workspaceSlug: string,
    epicPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        ids?: string;
        limit?: number;
        order_by?: "created_at" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<EpicCommentEntityListWrapper>
Parameters
- workspaceSlug: string
- epicPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      ids?: string;
      limit?: number;
      order_by?: "created_at" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionalids?: string
    A comma-separated list of ids. If included, only those entities will be considered for listing.
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "created_at" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<EpicCommentEntityListWrapper>
Description
List Epic Comments returns a paginated list of all Comments for an Epic in the Workspace. Note that deleted comments will also be returned, but will have minimal information. The deleted comments are included as they may be parents to other comments.

Name
ListEpicComments

Request
GET:/api/v4/{workspace-slug}/epics/{epic-public-id}/comments

Secure
Inherited from Api.listEpicComments
- Defined in src/v4/generated/Api.ts:2258

listEpicFollowers

listEpicFollowers(
    workspaceSlug: string,
    epicPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_disabled" | "include_disabled";
        limit?: number;
        order_by?: "name";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<EpicFollowerEntityListWrapper>
Parameters
- workspaceSlug: string
- epicPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_disabled" | "include_disabled";
      limit?: number;
      order_by?: "name";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_disabled" | "include_disabled"
    Filter options (default: :exclude_disabled).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<EpicFollowerEntityListWrapper>
Description
List Epic Followers returns a paginated list of all Members who are following an Epic in the Workspace.

Name
ListEpicFollowers

Request
GET:/api/v4/{workspace-slug}/epics/{epic-public-id}/followers

Secure
Inherited from Api.listEpicFollowers
- Defined in src/v4/generated/Api.ts:2326

listEpicHealths

listEpicHealths(
    workspaceSlug: string,
    epicPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "created_at" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<HealthEntityListWrapper>
Parameters
- workspaceSlug: string
- epicPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "created_at" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "created_at" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<HealthEntityListWrapper>
Description
Returns a paginated list of Health updates for the specified Epic.

Name
ListEpicHealths

Request
GET:/api/v4/{workspace-slug}/epics/{epic-public-id}/epic-healths

Secure
Inherited from Api.listEpicHealths
- Defined in src/v4/generated/Api.ts:2404

listEpicLabels

listEpicLabels(
    workspaceSlug: string,
    epicPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "name" | "created_at" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<EpicLabelEntityListWrapper>
Parameters
- workspaceSlug: string
- epicPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "name" | "created_at" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "created_at" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<EpicLabelEntityListWrapper>
Description
List Epic Labels returns a paginated list of all Labels for an Epic in the Workspace.

Name
ListEpicLabels

Request
GET:/api/v4/{workspace-slug}/epics/{epic-public-id}/labels

Secure
Inherited from Api.listEpicLabels
- Defined in src/v4/generated/Api.ts:2141

listEpicMentionedMembers

listEpicMentionedMembers(
    workspaceSlug: string,
    epicPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_disabled" | "include_disabled";
        limit?: number;
        order_by?: "name";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<EpicMentionedMemberEntityListWrapper>
Parameters
- workspaceSlug: string
- epicPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_disabled" | "include_disabled";
      limit?: number;
      order_by?: "name";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_disabled" | "include_disabled"
    Filter options (default: :exclude_disabled).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<EpicMentionedMemberEntityListWrapper>
Description
List Epic Mentioned Members returns a paginated list of all Members mentioned in an Epic in the Workspace.

Name
ListEpicMentionedMembers

Request
GET:/api/v4/{workspace-slug}/epics/{epic-public-id}/mentioned-members

Secure
Inherited from Api.listEpicMentionedMembers
- Defined in src/v4/generated/Api.ts:2615

listEpicMentionedTeams

listEpicMentionedTeams(
    workspaceSlug: string,
    epicPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "name" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<EpicMentionedTeamEntityListWrapper>
Parameters
- workspaceSlug: string
- epicPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "name" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<EpicMentionedTeamEntityListWrapper>
Description
List Epic Mentioned Teams returns a paginated list of all Teams mentioned in an Epic in the Workspace.

Name
ListEpicMentionedTeams

Request
GET:/api/v4/{workspace-slug}/epics/{epic-public-id}/mentioned-teams

Secure
Inherited from Api.listEpicMentionedTeams
- Defined in src/v4/generated/Api.ts:2576

listEpicObjectives

listEpicObjectives(
    workspaceSlug: string,
    epicPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<EpicObjectiveEntityListWrapper>
Parameters
- workspaceSlug: string
- epicPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<EpicObjectiveEntityListWrapper>
Description
List Epic Objectives returns a paginated list of all Objectives associated with an Epic in the Workspace.

Name
ListEpicObjectives

Request
GET:/api/v4/{workspace-slug}/epics/{epic-public-id}/objectives

Secure
Inherited from Api.listEpicObjectives
- Defined in src/v4/generated/Api.ts:2365

listEpicOwners

listEpicOwners(
    workspaceSlug: string,
    epicPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_disabled" | "include_disabled";
        limit?: number;
        order_by?: "name";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<EpicOwnerEntityListWrapper>
Parameters
- workspaceSlug: string
- epicPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_disabled" | "include_disabled";
      limit?: number;
      order_by?: "name";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_disabled" | "include_disabled"
    Filter options (default: :exclude_disabled).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<EpicOwnerEntityListWrapper>
Description
List Epic Owners returns a paginated list of all Members who own an Epic in the Workspace.

Name
ListEpicOwners

Request
GET:/api/v4/{workspace-slug}/epics/{epic-public-id}/owners

Secure
Inherited from Api.listEpicOwners
- Defined in src/v4/generated/Api.ts:2180

listEpics

listEpics(
    workspaceSlug: string,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<EpicEntityListWrapper>
Parameters
- workspaceSlug: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<EpicEntityListWrapper>
Description
List Epics returns a paginated list of all Epics in the Workspace.

Name
ListEpics

Request
GET:/api/v4/{workspace-slug}/epics

Secure
Inherited from Api.listEpics
- Defined in src/v4/generated/Api.ts:1799

listEpicStories

listEpicStories(
    workspaceSlug: string,
    epicPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "created_at" | "updated_at" | "position";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<EpicStoryEntityListWrapper>
Parameters
- workspaceSlug: string
- epicPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "created_at" | "updated_at" | "position";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "created_at" | "updated_at" | "position"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<EpicStoryEntityListWrapper>
Description
List Epic Stories returns a paginated list of all Stories associated with an Epic in the Workspace.

Name
ListEpicStories

Request
GET:/api/v4/{workspace-slug}/epics/{epic-public-id}/stories

Secure
Inherited from Api.listEpicStories
- Defined in src/v4/generated/Api.ts:2219

listEpicTeams

listEpicTeams(
    workspaceSlug: string,
    epicPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "name" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<EpicTeamEntityListWrapper>
Parameters
- workspaceSlug: string
- epicPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "name" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<EpicTeamEntityListWrapper>
Description
List Epic Teams returns a paginated list of all Teams associated with an Epic in the Workspace.

Name
ListEpicTeams

Request
GET:/api/v4/{workspace-slug}/epics/{epic-public-id}/teams

Secure
Inherited from Api.listEpicTeams
- Defined in src/v4/generated/Api.ts:2102

listEpicWorkflowStates

listEpicWorkflowStates(
    workspaceSlug: string,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "position";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<EpicStateEntityListWrapper>
Parameters
- workspaceSlug: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "position";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "position"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<EpicStateEntityListWrapper>
Description
Returns a paginated list of all Epic States in the Workspace's Epic Workflow.

Name
ListEpicWorkflowStates

Request
GET:/api/v4/{workspace-slug}/epic-workflow/states

Secure
Inherited from Api.listEpicWorkflowStates
- Defined in src/v4/generated/Api.ts:1761

listFileMentionedMembers

listFileMentionedMembers(
    workspaceSlug: string,
    filePublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_disabled" | "include_disabled";
        limit?: number;
        order_by?: "name";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<FileMentionedMemberEntityListWrapper>
Parameters
- workspaceSlug: string
- filePublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_disabled" | "include_disabled";
      limit?: number;
      order_by?: "name";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_disabled" | "include_disabled"
    Filter options (default: :exclude_disabled).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<FileMentionedMemberEntityListWrapper>
Description
List File Mentioned Members returns a paginated list of all Members mentioned in a File in the Workspace.

Name
ListFileMentionedMembers

Request
GET:/api/v4/{workspace-slug}/files/{file-public-id}/mentioned-members

Secure
Inherited from Api.listFileMentionedMembers
- Defined in src/v4/generated/Api.ts:3078

listFileMentionedTeams

listFileMentionedTeams(
    workspaceSlug: string,
    filePublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "name" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<FileMentionedTeamEntityListWrapper>
Parameters
- workspaceSlug: string
- filePublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "name" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<FileMentionedTeamEntityListWrapper>
Description
List File Mentioned Teams returns a paginated list of all Teams mentioned in a File in the Workspace.

Name
ListFileMentionedTeams

Request
GET:/api/v4/{workspace-slug}/files/{file-public-id}/mentioned-teams

Secure
Inherited from Api.listFileMentionedTeams
- Defined in src/v4/generated/Api.ts:3039

listFiles

listFiles(
    workspaceSlug: string,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<FileEntityListWrapper>
Parameters
- workspaceSlug: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<FileEntityListWrapper>
Description
List Files returns a paginated list of all Files in the Workspace.

Name
ListFiles

Request
GET:/api/v4/{workspace-slug}/files

Secure
Inherited from Api.listFiles
- Defined in src/v4/generated/Api.ts:2877

listFileStories

listFileStories(
    workspaceSlug: string,
    filePublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "created_at" | "updated_at" | "position";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<FileStoryEntityListWrapper>
Parameters
- workspaceSlug: string
- filePublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "created_at" | "updated_at" | "position";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "created_at" | "updated_at" | "position"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<FileStoryEntityListWrapper>
Description
List File Stories returns a paginated list of all Stories associated with a File in the Workspace.

Name
ListFileStories

Request
GET:/api/v4/{workspace-slug}/files/{file-public-id}/stories

Secure
Inherited from Api.listFileStories
- Defined in src/v4/generated/Api.ts:3000

listIterationAssociatedTeams

listIterationAssociatedTeams(
    workspaceSlug: string,
    iterationPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "name" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<IterationAssociatedTeamEntityListWrapper>
Parameters
- workspaceSlug: string
- iterationPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "name" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<IterationAssociatedTeamEntityListWrapper>
Description
List Iteration Associated Teams returns a paginated list of all Teams that own Stories in an Iteration but are not directly associated with the Iteration.

Name
ListIterationAssociatedTeams

Request
GET:/api/v4/{workspace-slug}/iterations/{iteration-public-id}/associated-teams

Secure
Inherited from Api.listIterationAssociatedTeams
- Defined in src/v4/generated/Api.ts:3624

listIterationFollowers

listIterationFollowers(
    workspaceSlug: string,
    iterationPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_disabled" | "include_disabled";
        limit?: number;
        order_by?: "name";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<IterationFollowerEntityListWrapper>
Parameters
- workspaceSlug: string
- iterationPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_disabled" | "include_disabled";
      limit?: number;
      order_by?: "name";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_disabled" | "include_disabled"
    Filter options (default: :exclude_disabled).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<IterationFollowerEntityListWrapper>
Description
List Iteration Followers returns a paginated list of all Members who are following an Iteration in the Workspace.

Name
ListIterationFollowers

Request
GET:/api/v4/{workspace-slug}/iterations/{iteration-public-id}/followers

Secure
Inherited from Api.listIterationFollowers
- Defined in src/v4/generated/Api.ts:3546

listIterationLabels

listIterationLabels(
    workspaceSlug: string,
    iterationPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "name" | "created_at" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<IterationLabelEntityListWrapper>
Parameters
- workspaceSlug: string
- iterationPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "name" | "created_at" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "created_at" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<IterationLabelEntityListWrapper>
Description
List Iteration Labels returns a paginated list of all Labels for an Iteration in the Workspace.

Name
ListIterationLabels

Request
GET:/api/v4/{workspace-slug}/iterations/{iteration-public-id}/labels

Secure
Inherited from Api.listIterationLabels
- Defined in src/v4/generated/Api.ts:3468

listIterationMentionedMembers

listIterationMentionedMembers(
    workspaceSlug: string,
    iterationPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_disabled" | "include_disabled";
        limit?: number;
        order_by?: "name";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<IterationMentionedMemberEntityListWrapper>
Parameters
- workspaceSlug: string
- iterationPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_disabled" | "include_disabled";
      limit?: number;
      order_by?: "name";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_disabled" | "include_disabled"
    Filter options (default: :exclude_disabled).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<IterationMentionedMemberEntityListWrapper>
Description
List Iteration Mentioned Members returns a paginated list of all Members mentioned in an Iteration in the Workspace.

Name
ListIterationMentionedMembers

Request
GET:/api/v4/{workspace-slug}/iterations/{iteration-public-id}/mentioned-members

Secure
Inherited from Api.listIterationMentionedMembers
- Defined in src/v4/generated/Api.ts:3663

listIterationMentionedTeams

listIterationMentionedTeams(
    workspaceSlug: string,
    iterationPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "name" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<IterationMentionedTeamEntityListWrapper>
Parameters
- workspaceSlug: string
- iterationPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "name" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<IterationMentionedTeamEntityListWrapper>
Description
List Iteration Mentioned Teams returns a paginated list of all Teams mentioned in an Iteration in the Workspace.

Name
ListIterationMentionedTeams

Request
GET:/api/v4/{workspace-slug}/iterations/{iteration-public-id}/mentioned-teams

Secure
Inherited from Api.listIterationMentionedTeams
- Defined in src/v4/generated/Api.ts:3585

listIterations

listIterations(
    workspaceSlug: string,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "updated_at" | "start_date";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<IterationEntityListWrapper>
Parameters
- workspaceSlug: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "updated_at" | "start_date";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at" | "start_date"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<IterationEntityListWrapper>
Description
List Iterations returns a paginated list of all Iterations in the Workspace.

Name
ListIterations

Request
GET:/api/v4/{workspace-slug}/iterations

Secure
Inherited from Api.listIterations
- Defined in src/v4/generated/Api.ts:3117

listIterationStories

listIterationStories(
    workspaceSlug: string,
    iterationPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "created_at" | "updated_at" | "position";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<IterationStoryEntityListWrapper>
Parameters
- workspaceSlug: string
- iterationPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "created_at" | "updated_at" | "position";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "created_at" | "updated_at" | "position"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<IterationStoryEntityListWrapper>
Description
List Iteration Stories returns a paginated list of all Stories in an Iteration in the Workspace.

Name
ListIterationStories

Request
GET:/api/v4/{workspace-slug}/iterations/{iteration-public-id}/stories

Secure
Inherited from Api.listIterationStories
- Defined in src/v4/generated/Api.ts:3507

listIterationTeams

listIterationTeams(
    workspaceSlug: string,
    iterationPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "name" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<IterationTeamEntityListWrapper>
Parameters
- workspaceSlug: string
- iterationPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "name" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<IterationTeamEntityListWrapper>
Description
List Iteration Teams returns a paginated list of all Teams directly associated with an Iteration in the Workspace.

Name
ListIterationTeams

Request
GET:/api/v4/{workspace-slug}/iterations/{iteration-public-id}/teams

Secure
Inherited from Api.listIterationTeams
- Defined in src/v4/generated/Api.ts:3429

listKeyResults

listKeyResults(
    workspaceSlug: string,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<KeyResultEntityListWrapper>
Parameters
- workspaceSlug: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<KeyResultEntityListWrapper>
Description
Returns a paginated list of all Key Results in the Workspace.

Name
ListKeyResults

Request
GET:/api/v4/{workspace-slug}/key-results

Secure
Inherited from Api.listKeyResults
- Defined in src/v4/generated/Api.ts:3702

listLabelEpics

listLabelEpics(
    workspaceSlug: string,
    labelPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<LabelEpicEntityListWrapper>
Parameters
- workspaceSlug: string
- labelPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<LabelEpicEntityListWrapper>
Description
List Label Epics returns a paginated list of all Epics that have a given Label.

Name
ListLabelEpics

Request
GET:/api/v4/{workspace-slug}/labels/{label-public-id}/epics

Secure
Inherited from Api.listLabelEpics
- Defined in src/v4/generated/Api.ts:4028

listLabels

listLabels(
    workspaceSlug: string,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "name" | "created_at" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<LabelEntityListWrapper>
Parameters
- workspaceSlug: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "name" | "created_at" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "created_at" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<LabelEntityListWrapper>
Description
List Labels returns a paginated list of all Labels in the Workspace.

Name
ListLabels

Request
GET:/api/v4/{workspace-slug}/labels

Secure
Inherited from Api.listLabels
- Defined in src/v4/generated/Api.ts:3791

listLabelStories

listLabelStories(
    workspaceSlug: string,
    labelPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "created_at" | "updated_at" | "position";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<LabelStoryEntityListWrapper>
Parameters
- workspaceSlug: string
- labelPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "created_at" | "updated_at" | "position";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "created_at" | "updated_at" | "position"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<LabelStoryEntityListWrapper>
Description
List Label Stories returns a paginated list of all Stories that have a given Label.

Name
ListLabelStories

Request
GET:/api/v4/{workspace-slug}/labels/{label-public-id}/stories

Secure
Inherited from Api.listLabelStories
- Defined in src/v4/generated/Api.ts:4067

listLinkedFileMentionedMembers

listLinkedFileMentionedMembers(
    workspaceSlug: string,
    linkedFilePublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_disabled" | "include_disabled";
        limit?: number;
        order_by?: "name";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<LinkedFileMentionedMemberEntityListWrapper>
Parameters
- workspaceSlug: string
- linkedFilePublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_disabled" | "include_disabled";
      limit?: number;
      order_by?: "name";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_disabled" | "include_disabled"
    Filter options (default: :exclude_disabled).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<LinkedFileMentionedMemberEntityListWrapper>
Description
List Linked File Mentioned Members returns a paginated list of all Members mentioned in a Linked File in the Workspace.

Name
ListLinkedFileMentionedMembers

Request
GET:/api/v4/{workspace-slug}/linked-files/{linked-file-public-id}/mentioned-members

Secure
Inherited from Api.listLinkedFileMentionedMembers
- Defined in src/v4/generated/Api.ts:4421

listLinkedFileMentionedTeams

listLinkedFileMentionedTeams(
    workspaceSlug: string,
    linkedFilePublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "name" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<LinkedFileMentionedTeamEntityListWrapper>
Parameters
- workspaceSlug: string
- linkedFilePublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "name" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<LinkedFileMentionedTeamEntityListWrapper>
Description
List Linked File Mentioned Teams returns a paginated list of all Teams mentioned in a Linked File in the Workspace.

Name
ListLinkedFileMentionedTeams

Request
GET:/api/v4/{workspace-slug}/linked-files/{linked-file-public-id}/mentioned-teams

Secure
Inherited from Api.listLinkedFileMentionedTeams
- Defined in src/v4/generated/Api.ts:4382

listLinkedFiles

listLinkedFiles(
    workspaceSlug: string,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<LinkedFileEntityListWrapper>
Parameters
- workspaceSlug: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<LinkedFileEntityListWrapper>
Description
List Linked Files returns a paginated list of all Linked Files in the Workspace.

Name
ListLinkedFiles

Request
GET:/api/v4/{workspace-slug}/linked-files

Secure
Inherited from Api.listLinkedFiles
- Defined in src/v4/generated/Api.ts:4106

listLinkedFileStories

listLinkedFileStories(
    workspaceSlug: string,
    linkedFilePublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "created_at" | "updated_at" | "position";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<LinkedFileStoryEntityListWrapper>
Parameters
- workspaceSlug: string
- linkedFilePublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "created_at" | "updated_at" | "position";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "created_at" | "updated_at" | "position"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<LinkedFileStoryEntityListWrapper>
Description
List Linked File Stories returns a paginated list of all Stories associated with a Linked File in the Workspace.

Name
ListLinkedFileStories

Request
GET:/api/v4/{workspace-slug}/linked-files/{linked-file-public-id}/stories

Secure
Inherited from Api.listLinkedFileStories
- Defined in src/v4/generated/Api.ts:4343

listMembers

listMembers(
    workspaceSlug: string,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_disabled" | "include_disabled";
        limit?: number;
        order_by?: "name";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<MemberEntityListWrapper>
Parameters
- workspaceSlug: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_disabled" | "include_disabled";
      limit?: number;
      order_by?: "name";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_disabled" | "include_disabled"
    Filter options (default: :exclude_disabled).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<MemberEntityListWrapper>
Description
List Members returns a paginated list of all Members in the Workspace.

Name
ListMembers

Request
GET:/api/v4/{workspace-slug}/members

Secure
Inherited from Api.listMembers
- Defined in src/v4/generated/Api.ts:4460

listMemberStories

listMemberStories(
    workspaceSlug: string,
    memberPublicId: string,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "created_at" | "updated_at" | "position";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<MemberStoryEntityListWrapper>
Parameters
- workspaceSlug: string
- memberPublicId: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "created_at" | "updated_at" | "position";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "created_at" | "updated_at" | "position"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<MemberStoryEntityListWrapper>
Description
Returns a paginated list of all Stories owned by the specified Member.

Name
ListMemberStories

Request
GET:/api/v4/{workspace-slug}/members/{member-public-id}/stories

Secure
Inherited from Api.listMemberStories
- Defined in src/v4/generated/Api.ts:4629

listMemberTeams

listMemberTeams(
    workspaceSlug: string,
    memberPublicId: string,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "name" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<MemberTeamEntityListWrapper>
Parameters
- workspaceSlug: string
- memberPublicId: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "name" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<MemberTeamEntityListWrapper>
Description
Returns a paginated list of all Teams the Member belongs to.

Name
ListMemberTeams

Request
GET:/api/v4/{workspace-slug}/members/{member-public-id}/teams

Secure
Inherited from Api.listMemberTeams
- Defined in src/v4/generated/Api.ts:4590

listObjectiveCategories

listObjectiveCategories(
    workspaceSlug: string,
    objectivePublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "name" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<ObjectiveCategoryEntityListWrapper>
Parameters
- workspaceSlug: string
- objectivePublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "name" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<ObjectiveCategoryEntityListWrapper>
Description
List Objective Categories returns a paginated list of all Categories associated with an Objective in the Workspace.

Name
ListObjectiveCategories

Request
GET:/api/v4/{workspace-slug}/objectives/{objective-public-id}/categories

Secure
Inherited from Api.listObjectiveCategories
- Defined in src/v4/generated/Api.ts:5059

listObjectiveEpics

listObjectiveEpics(
    workspaceSlug: string,
    objectivePublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<ObjectiveEpicEntityListWrapper>
Parameters
- workspaceSlug: string
- objectivePublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<ObjectiveEpicEntityListWrapper>
Description
List Objective Epics returns a paginated list of all Epics associated with an Objective in the Workspace.

Name
ListObjectiveEpics

Request
GET:/api/v4/{workspace-slug}/objectives/{objective-public-id}/epics

Secure
Inherited from Api.listObjectiveEpics
- Defined in src/v4/generated/Api.ts:4942

listObjectiveHealths

listObjectiveHealths(
    workspaceSlug: string,
    objectivePublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "created_at" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<HealthEntityListWrapper>
Parameters
- workspaceSlug: string
- objectivePublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "created_at" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "created_at" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<HealthEntityListWrapper>
Description
Returns a paginated list of Health updates for the specified Objective.

Name
ListObjectiveHealths

Request
GET:/api/v4/{workspace-slug}/objectives/{objective-public-id}/objective-healths

Secure
Inherited from Api.listObjectiveHealths
- Defined in src/v4/generated/Api.ts:5137

listObjectiveKeyResults

listObjectiveKeyResults(
    workspaceSlug: string,
    objectivePublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<ObjectiveKeyResultEntityListWrapper>
Parameters
- workspaceSlug: string
- objectivePublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<ObjectiveKeyResultEntityListWrapper>
Description
List Objective Key Results returns a paginated list of all Key Results associated with an Objective in the Workspace.

Name
ListObjectiveKeyResults

Request
GET:/api/v4/{workspace-slug}/objectives/{objective-public-id}/key-results

Secure
Inherited from Api.listObjectiveKeyResults
- Defined in src/v4/generated/Api.ts:5098

listObjectiveOwners

listObjectiveOwners(
    workspaceSlug: string,
    objectivePublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_disabled" | "include_disabled";
        limit?: number;
        order_by?: "name";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<ObjectiveOwnerEntityListWrapper>
Parameters
- workspaceSlug: string
- objectivePublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_disabled" | "include_disabled";
      limit?: number;
      order_by?: "name";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_disabled" | "include_disabled"
    Filter options (default: :exclude_disabled).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<ObjectiveOwnerEntityListWrapper>
Description
List Objective Owners returns a paginated list of all Members who own an Objective in the Workspace.

Name
ListObjectiveOwners

Request
GET:/api/v4/{workspace-slug}/objectives/{objective-public-id}/owners

Secure
Inherited from Api.listObjectiveOwners
- Defined in src/v4/generated/Api.ts:5020

listObjectives

listObjectives(
    workspaceSlug: string,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<ObjectiveEntityListWrapper>
Parameters
- workspaceSlug: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<ObjectiveEntityListWrapper>
Description
List Objectives returns a paginated list of all Objectives in the Workspace.

Name
ListObjectives

Request
GET:/api/v4/{workspace-slug}/objectives

Secure
Inherited from Api.listObjectives
- Defined in src/v4/generated/Api.ts:4668

listObjectiveTeams

listObjectiveTeams(
    workspaceSlug: string,
    objectivePublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "name" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<ObjectiveTeamEntityListWrapper>
Parameters
- workspaceSlug: string
- objectivePublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "name" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<ObjectiveTeamEntityListWrapper>
Description
List Objective Teams returns a paginated list of all Teams associated with an Objective in the Workspace.

Name
ListObjectiveTeams

Request
GET:/api/v4/{workspace-slug}/objectives/{objective-public-id}/teams

Secure
Inherited from Api.listObjectiveTeams
- Defined in src/v4/generated/Api.ts:4981

listProjectFollowers

listProjectFollowers(
    workspaceSlug: string,
    projectPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_disabled" | "include_disabled";
        limit?: number;
        order_by?: "name";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<ProjectFollowerEntityListWrapper>
Parameters
- workspaceSlug: string
- projectPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_disabled" | "include_disabled";
      limit?: number;
      order_by?: "name";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_disabled" | "include_disabled"
    Filter options (default: :exclude_disabled).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<ProjectFollowerEntityListWrapper>
Description
List Project Followers returns a paginated list of all Members following a Project. Projects are a deprecated feature.

Name
ListProjectFollowers

Request
GET:/api/v4/{workspace-slug}/projects/{project-public-id}/followers

Deprecated
Secure
Inherited from Api.listProjectFollowers
- Defined in src/v4/generated/Api.ts:5408

listProjects

listProjects(
    workspaceSlug: string,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<ProjectEntityListWrapper>
Parameters
- workspaceSlug: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<ProjectEntityListWrapper>
Description
List Projects returns a paginated list of all Projects in the Workspace. Projects are a deprecated feature.

Name
ListProjects

Request
GET:/api/v4/{workspace-slug}/projects

Deprecated
Secure
Inherited from Api.listProjects
- Defined in src/v4/generated/Api.ts:5229

listProjectStories

listProjectStories(
    workspaceSlug: string,
    projectPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "created_at" | "updated_at" | "position";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<ProjectStoryEntityListWrapper>
Parameters
- workspaceSlug: string
- projectPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "created_at" | "updated_at" | "position";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "created_at" | "updated_at" | "position"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<ProjectStoryEntityListWrapper>
Description
List Project Stories returns a paginated list of all Stories associated with a Project. Projects are a deprecated feature.

Name
ListProjectStories

Request
GET:/api/v4/{workspace-slug}/projects/{project-public-id}/stories

Deprecated
Secure
Inherited from Api.listProjectStories
- Defined in src/v4/generated/Api.ts:5368

listPullRequests

listPullRequests(
    workspaceSlug: string,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_closed" | "include_closed";
        limit?: number;
        order_by?: "created_at" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<PullRequestEntityListWrapper>
Parameters
- workspaceSlug: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_closed" | "include_closed";
      limit?: number;
      order_by?: "created_at" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_closed" | "include_closed"
    Filter options (default: :include_closed).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "created_at" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<PullRequestEntityListWrapper>
Description
List Pull Requests returns a paginated list of all Pull Requests in the Workspace that have been associated with a Story.

Name
ListPullRequests

Request
GET:/api/v4/{workspace-slug}/pull-requests

Secure
Inherited from Api.listPullRequests
- Defined in src/v4/generated/Api.ts:5447

listPullRequestStories

listPullRequestStories(
    workspaceSlug: string,
    pullRequestPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "created_at" | "updated_at" | "position";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<PullRequestStoryEntityListWrapper>
Parameters
- workspaceSlug: string
- pullRequestPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "created_at" | "updated_at" | "position";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "created_at" | "updated_at" | "position"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<PullRequestStoryEntityListWrapper>
Description
List Pull Request Stories returns a paginated list of all Stories associated with a Pull Request in the Workspace.

Name
ListPullRequestStories

Request
GET:/api/v4/{workspace-slug}/pull-requests/{pull-request-public-id}/stories

Secure
Inherited from Api.listPullRequestStories
- Defined in src/v4/generated/Api.ts:5509

listRepositories

listRepositories(
    workspaceSlug: string,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "name" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<RepositoryEntityListWrapper>
Parameters
- workspaceSlug: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "name" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<RepositoryEntityListWrapper>
Description
List Repositories returns a paginated list of all connected Repositories in the Workspace.

Name
ListRepositories

Request
GET:/api/v4/{workspace-slug}/repositories

Secure
Inherited from Api.listRepositories
- Defined in src/v4/generated/Api.ts:5548

listRepositoryBranches

listRepositoryBranches(
    workspaceSlug: string,
    repositoryPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_deleted" | "include_deleted";
        limit?: number;
        order_by?: "name" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<RepositoryBranchEntityListWrapper>
Parameters
- workspaceSlug: string
- repositoryPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_deleted" | "include_deleted";
      limit?: number;
      order_by?: "name" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_deleted" | "include_deleted"
    Filter options (default: :exclude_deleted).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<RepositoryBranchEntityListWrapper>
Description
List Repository Branches returns a paginated list of all Branches associated with a Repository in the Workspace.

Name
ListRepositoryBranches

Request
GET:/api/v4/{workspace-slug}/repositories/{repository-public-id}/branches

Secure
Inherited from Api.listRepositoryBranches
- Defined in src/v4/generated/Api.ts:5649

listRepositoryCommits

listRepositoryCommits(
    workspaceSlug: string,
    repositoryPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<RepositoryCommitEntityListWrapper>
Parameters
- workspaceSlug: string
- repositoryPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<RepositoryCommitEntityListWrapper>
Description
List Repository Commits returns a paginated list of all Commits associated with a Repository in the Workspace.

Name
ListRepositoryCommits

Request
GET:/api/v4/{workspace-slug}/repositories/{repository-public-id}/commits

Secure
Inherited from Api.listRepositoryCommits
- Defined in src/v4/generated/Api.ts:5610

listRepositoryPullRequests

listRepositoryPullRequests(
    workspaceSlug: string,
    repositoryPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_closed" | "include_closed";
        limit?: number;
        order_by?: "created_at" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<RepositoryPullRequestEntityListWrapper>
Parameters
- workspaceSlug: string
- repositoryPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_closed" | "include_closed";
      limit?: number;
      order_by?: "created_at" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_closed" | "include_closed"
    Filter options (default: :include_closed).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "created_at" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<RepositoryPullRequestEntityListWrapper>
Description
List Repository Pull Requests returns a paginated list of all Pull Requests associated with a Repository in the Workspace.

Name
ListRepositoryPullRequests

Request
GET:/api/v4/{workspace-slug}/repositories/{repository-public-id}/pull-requests

Secure
Inherited from Api.listRepositoryPullRequests
- Defined in src/v4/generated/Api.ts:5688

listStories

listStories(
    workspaceSlug: string,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        ids?: string;
        limit?: number;
        order_by?: "created_at" | "updated_at" | "position";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StoryEntityListWrapper>
Parameters
- workspaceSlug: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      ids?: string;
      limit?: number;
      order_by?: "created_at" | "updated_at" | "position";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionalids?: string
    A comma-separated list of ids. If included, only those entities will be considered for listing.
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "created_at" | "updated_at" | "position"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<StoryEntityListWrapper>
Description
List Stories returns a paginated list of all Stories in the Workspace.

Name
ListStories

Request
GET:/api/v4/{workspace-slug}/stories

Secure
Inherited from Api.listStories
- Defined in src/v4/generated/Api.ts:5767

listStoryBranches

listStoryBranches(
    workspaceSlug: string,
    storyPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_deleted" | "include_deleted";
        limit?: number;
        order_by?: "name" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StoryBranchEntityListWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_deleted" | "include_deleted";
      limit?: number;
      order_by?: "name" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_deleted" | "include_deleted"
    Filter options (default: :exclude_deleted).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<StoryBranchEntityListWrapper>
Description
List Story Branches returns a paginated list of all Branches for a Story in the Workspace.

Name
ListStoryBranches

Request
GET:/api/v4/{workspace-slug}/stories/{story-public-id}/branches

Secure
Inherited from Api.listStoryBranches
- Defined in src/v4/generated/Api.ts:6280

listStoryChecklistItemMentionedMembers

listStoryChecklistItemMentionedMembers(
    workspaceSlug: string,
    storyPublicId: number,
    checklistItemPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_disabled" | "include_disabled";
        limit?: number;
        order_by?: "name";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StoryChecklistItemMentionedMemberEntityListWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- checklistItemPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_disabled" | "include_disabled";
      limit?: number;
      order_by?: "name";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_disabled" | "include_disabled"
    Filter options (default: :exclude_disabled).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<StoryChecklistItemMentionedMemberEntityListWrapper>
Description
List Story Checklist Item Mentioned Members returns a paginated list of all Members mentioned in a Story Checklist Item in the Workspace.

Name
ListStoryChecklistItemMentionedMembers

Request
GET:/api/v4/{workspace-slug}/stories/{story-public-id}/checklist-items/{checklist-item-public-id}/mentioned-members

Secure
Inherited from Api.listStoryChecklistItemMentionedMembers
- Defined in src/v4/generated/Api.ts:7462

listStoryChecklistItemMentionedTeams

listStoryChecklistItemMentionedTeams(
    workspaceSlug: string,
    storyPublicId: number,
    checklistItemPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "name" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StoryChecklistItemMentionedTeamEntityListWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- checklistItemPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "name" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<StoryChecklistItemMentionedTeamEntityListWrapper>
Description
List Story Checklist Item Mentioned Teams returns a paginated list of all Teams mentioned in a Story Checklist Item in the Workspace.

Name
ListStoryChecklistItemMentionedTeams

Request
GET:/api/v4/{workspace-slug}/stories/{story-public-id}/checklist-items/{checklist-item-public-id}/mentioned-teams

Secure
Inherited from Api.listStoryChecklistItemMentionedTeams
- Defined in src/v4/generated/Api.ts:7401

listStoryChecklistItems

listStoryChecklistItems(
    workspaceSlug: string,
    storyPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        ids?: string;
        limit?: number;
        order_by?: "position";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StoryChecklistItemEntityListWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      ids?: string;
      limit?: number;
      order_by?: "position";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionalids?: string
    A comma-separated list of ids. If included, only those entities will be considered for listing.
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "position"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<StoryChecklistItemEntityListWrapper>
Description
List Story Checklist Items returns a paginated list of all Checklist Items for a Story in the Workspace.

Name
ListStoryChecklistItems

Request
GET:/api/v4/{workspace-slug}/stories/{story-public-id}/checklist-items

Secure
Inherited from Api.listStoryChecklistItems
- Defined in src/v4/generated/Api.ts:6727

listStoryCommentComments

listStoryCommentComments(
    workspaceSlug: string,
    storyPublicId: number,
    commentPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "position";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StoryCommentCommentEntityListWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- commentPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "position";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "position"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<StoryCommentCommentEntityListWrapper>
Description
List Story Comment Comments returns a paginated list of all threaded reply Comments for a Story Comment in the Workspace.

Name
ListStoryCommentComments

Request
GET:/api/v4/{workspace-slug}/stories/{story-public-id}/comments/{comment-public-id}/comments

Secure
Inherited from Api.listStoryCommentComments
- Defined in src/v4/generated/Api.ts:7135

listStoryCommentMentionedMembers

listStoryCommentMentionedMembers(
    workspaceSlug: string,
    storyPublicId: number,
    commentPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_disabled" | "include_disabled";
        limit?: number;
        order_by?: "name";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StoryCommentMentionedMemberEntityListWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- commentPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_disabled" | "include_disabled";
      limit?: number;
      order_by?: "name";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_disabled" | "include_disabled"
    Filter options (default: :exclude_disabled).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<StoryCommentMentionedMemberEntityListWrapper>
Description
List Story Comment Mentioned Members returns a paginated list of all Members mentioned in a Story Comment in the Workspace.

Name
ListStoryCommentMentionedMembers

Request
GET:/api/v4/{workspace-slug}/stories/{story-public-id}/comments/{comment-public-id}/mentioned-members

Secure
Inherited from Api.listStoryCommentMentionedMembers
- Defined in src/v4/generated/Api.ts:7361

listStoryCommentMentionedTeams

listStoryCommentMentionedTeams(
    workspaceSlug: string,
    storyPublicId: number,
    commentPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "name" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StoryCommentMentionedTeamEntityListWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- commentPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "name" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<StoryCommentMentionedTeamEntityListWrapper>
Description
List Story Comment Mentioned Teams returns a paginated list of all Teams mentioned in a Story Comment in the Workspace.

Name
ListStoryCommentMentionedTeams

Request
GET:/api/v4/{workspace-slug}/stories/{story-public-id}/comments/{comment-public-id}/mentioned-teams

Secure
Inherited from Api.listStoryCommentMentionedTeams
- Defined in src/v4/generated/Api.ts:7321

listStoryCommentReactions

listStoryCommentReactions(
    workspaceSlug: string,
    storyPublicId: number,
    commentPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "created_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StoryCommentReactionEntityListWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- commentPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "created_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "created_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<StoryCommentReactionEntityListWrapper>
Description
List Story Comment Reactions returns a paginated list of all Reactions to a Story Comment in the Workspace.

Name
ListStoryCommentReactions

Request
GET:/api/v4/{workspace-slug}/stories/{story-public-id}/comments/{comment-public-id}/reactions

Secure
Inherited from Api.listStoryCommentReactions
- Defined in src/v4/generated/Api.ts:7175

listStoryComments

listStoryComments(
    workspaceSlug: string,
    storyPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        ids?: string;
        limit?: number;
        order_by?: "position";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StoryCommentEntityListWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      ids?: string;
      limit?: number;
      order_by?: "position";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionalids?: string
    A comma-separated list of ids. If included, only those entities will be considered for listing.
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "position"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<StoryCommentEntityListWrapper>
Description
List Story Comments returns a paginated list of all Comments for a Story in the Workspace. Note that deleted comments will also be returned, but will have minimal information. The deleted comments are included as they may be parents to other comments.

Name
ListStoryComments

Request
GET:/api/v4/{workspace-slug}/stories/{story-public-id}/comments

Secure
Inherited from Api.listStoryComments
- Defined in src/v4/generated/Api.ts:6319

listStoryCommits

listStoryCommits(
    workspaceSlug: string,
    storyPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StoryCommitEntityListWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<StoryCommitEntityListWrapper>
Description
List Story Commits returns a paginated list of all Commits associated with a Story in the Workspace.

Name
ListStoryCommits

Request
GET:/api/v4/{workspace-slug}/stories/{story-public-id}/commits

Secure
Inherited from Api.listStoryCommits
- Defined in src/v4/generated/Api.ts:6206

listStoryCustomFieldValues

listStoryCustomFieldValues(
    workspaceSlug: string,
    storyPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "field_name";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StoryCustomFieldValueEntityListWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "field_name";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "field_name"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<StoryCustomFieldValueEntityListWrapper>
Description
List Story Custom Field Values returns a paginated list of all Custom Field Values for a Story in the Workspace.

Name
ListStoryCustomFieldValues

Request
GET:/api/v4/{workspace-slug}/stories/{story-public-id}/custom-field-values

Secure
Inherited from Api.listStoryCustomFieldValues
- Defined in src/v4/generated/Api.ts:6912

listStoryExternalLinks

listStoryExternalLinks(
    workspaceSlug: string,
    storyPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "value";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StoryExternalLinkEntityListWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "value";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "value"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<StoryExternalLinkEntityListWrapper>
Description
List Story External Links returns a paginated list of all External Links for a Story in the Workspace.

Name
ListStoryExternalLinks

Request
GET:/api/v4/{workspace-slug}/stories/{story-public-id}/external-links

Secure
Inherited from Api.listStoryExternalLinks
- Defined in src/v4/generated/Api.ts:6688

listStoryFiles

listStoryFiles(
    workspaceSlug: string,
    storyPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StoryFileEntityListWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<StoryFileEntityListWrapper>
Description
List Story Files returns a paginated list of all Files attached to a Story in the Workspace.

Name
ListStoryFiles

Request
GET:/api/v4/{workspace-slug}/stories/{story-public-id}/files

Secure
Inherited from Api.listStoryFiles
- Defined in src/v4/generated/Api.ts:6089

listStoryFollowers

listStoryFollowers(
    workspaceSlug: string,
    storyPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_disabled" | "include_disabled";
        limit?: number;
        order_by?: "name";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StoryFollowerEntityListWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_disabled" | "include_disabled";
      limit?: number;
      order_by?: "name";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_disabled" | "include_disabled"
    Filter options (default: :exclude_disabled).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<StoryFollowerEntityListWrapper>
Description
List Story Followers returns a paginated list of all Members who are following a Story in the Workspace.

Name
ListStoryFollowers

Request
GET:/api/v4/{workspace-slug}/stories/{story-public-id}/followers

Secure
Inherited from Api.listStoryFollowers
- Defined in src/v4/generated/Api.ts:6387

listStoryIterations

listStoryIterations(
    workspaceSlug: string,
    storyPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "updated_at" | "start_date";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StoryIterationEntityListWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "updated_at" | "start_date";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at" | "start_date"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<StoryIterationEntityListWrapper>
Description
List Story Iterations returns a paginated list of all Iterations associated with a Story in the Workspace.

Name
ListStoryIterations

Request
GET:/api/v4/{workspace-slug}/stories/{story-public-id}/iterations

Secure
Inherited from Api.listStoryIterations
- Defined in src/v4/generated/Api.ts:6426

listStoryLabels

listStoryLabels(
    workspaceSlug: string,
    storyPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "name" | "created_at" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StoryLabelEntityListWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "name" | "created_at" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "created_at" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<StoryLabelEntityListWrapper>
Description
List Story Labels returns a paginated list of all Labels for a Story in the Workspace.

Name
ListStoryLabels

Request
GET:/api/v4/{workspace-slug}/stories/{story-public-id}/labels

Secure
Inherited from Api.listStoryLabels
- Defined in src/v4/generated/Api.ts:6128

listStoryLinkedFiles

listStoryLinkedFiles(
    workspaceSlug: string,
    storyPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StoryLinkedFileEntityListWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<StoryLinkedFileEntityListWrapper>
Description
List Story Linked Files returns a paginated list of all Linked Files attached to a Story in the Workspace.

Name
ListStoryLinkedFiles

Request
GET:/api/v4/{workspace-slug}/stories/{story-public-id}/linked-files

Secure
Inherited from Api.listStoryLinkedFiles
- Defined in src/v4/generated/Api.ts:6504

listStoryLinks

listStoryLinks(
    workspaceSlug: string,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StoryLinkEntityListWrapper>
Parameters
- workspaceSlug: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<StoryLinkEntityListWrapper>
Description
List Story Links returns a paginated list of all Story Links in the Workspace.

Name
ListStoryLinks

Request
GET:/api/v4/{workspace-slug}/story-links

Secure
Inherited from Api.listStoryLinks
- Defined in src/v4/generated/Api.ts:7502

listStoryMentionedMembers

listStoryMentionedMembers(
    workspaceSlug: string,
    storyPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_disabled" | "include_disabled";
        limit?: number;
        order_by?: "name";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StoryMentionedMemberEntityListWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_disabled" | "include_disabled";
      limit?: number;
      order_by?: "name";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_disabled" | "include_disabled"
    Filter options (default: :exclude_disabled).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<StoryMentionedMemberEntityListWrapper>
Description
List Story Mentioned Members returns a paginated list of all Members mentioned in a Story in the Workspace.

Name
ListStoryMentionedMembers

Request
GET:/api/v4/{workspace-slug}/stories/{story-public-id}/mentioned-members

Secure
Inherited from Api.listStoryMentionedMembers
- Defined in src/v4/generated/Api.ts:6873

listStoryMentionedTeams

listStoryMentionedTeams(
    workspaceSlug: string,
    storyPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "name" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StoryMentionedTeamEntityListWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "name" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<StoryMentionedTeamEntityListWrapper>
Description
List Story Mentioned Teams returns a paginated list of all Teams mentioned in a Story in the Workspace.

Name
ListStoryMentionedTeams

Request
GET:/api/v4/{workspace-slug}/stories/{story-public-id}/mentioned-teams

Secure
Inherited from Api.listStoryMentionedTeams
- Defined in src/v4/generated/Api.ts:6795

listStoryOwners

listStoryOwners(
    workspaceSlug: string,
    storyPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_disabled" | "include_disabled";
        limit?: number;
        order_by?: "name";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StoryOwnerEntityListWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_disabled" | "include_disabled";
      limit?: number;
      order_by?: "name";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_disabled" | "include_disabled"
    Filter options (default: :exclude_disabled).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<StoryOwnerEntityListWrapper>
Description
List Story Owners returns a paginated list of all Members who own a Story in the Workspace.

Name
ListStoryOwners

Request
GET:/api/v4/{workspace-slug}/stories/{story-public-id}/owners

Secure
Inherited from Api.listStoryOwners
- Defined in src/v4/generated/Api.ts:6167

listStoryPullRequests

listStoryPullRequests(
    workspaceSlug: string,
    storyPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_closed" | "include_closed";
        limit?: number;
        order_by?: "created_at" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StoryPullRequestEntityListWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_closed" | "include_closed";
      limit?: number;
      order_by?: "created_at" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_closed" | "include_closed"
    Filter options (default: :include_closed).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "created_at" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<StoryPullRequestEntityListWrapper>
Description
List Story Pull Requests returns a paginated list of all Pull Requests associated with a Story in the Workspace.

Name
ListStoryPullRequests

Request
GET:/api/v4/{workspace-slug}/stories/{story-public-id}/pull-requests

Secure
Inherited from Api.listStoryPullRequests
- Defined in src/v4/generated/Api.ts:6649

listStoryStoryLinks

listStoryStoryLinks(
    workspaceSlug: string,
    storyPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StoryStoryLinkEntityListWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<StoryStoryLinkEntityListWrapper>
Description
List Story Story Links returns a paginated list of all Story Links associated with a Story in the Workspace. This includes links where the Story is either the subject or the object of the relationship.

Name
ListStoryStoryLinks

Request
GET:/api/v4/{workspace-slug}/stories/{story-public-id}/story-links

Secure
Inherited from Api.listStoryStoryLinks
- Defined in src/v4/generated/Api.ts:6465

listStorySubTaskStories

listStorySubTaskStories(
    workspaceSlug: string,
    storyPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "created_at" | "updated_at" | "position";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<StorySubTaskStoryEntityListWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "created_at" | "updated_at" | "position";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "created_at" | "updated_at" | "position"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<StorySubTaskStoryEntityListWrapper>
Description
List Story Sub-Task Stories returns a paginated list of all Sub-Task Stories for a Story in the Workspace.

Name
ListStorySubTaskStories

Request
GET:/api/v4/{workspace-slug}/stories/{story-public-id}/sub-task-stories

Secure
Inherited from Api.listStorySubTaskStories
- Defined in src/v4/generated/Api.ts:6834

listTeamMembers

listTeamMembers(
    workspaceSlug: string,
    teamPublicId: string,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_disabled" | "include_disabled";
        limit?: number;
        order_by?: "name";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<TeamMemberEntityListWrapper>
Parameters
- workspaceSlug: string
- teamPublicId: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_disabled" | "include_disabled";
      limit?: number;
      order_by?: "name";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_disabled" | "include_disabled"
    Filter options (default: :exclude_disabled).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<TeamMemberEntityListWrapper>
Description
Returns a paginated list of all Members for the specified Team.

Name
ListTeamMembers

Request
GET:/api/v4/{workspace-slug}/teams/{team-public-id}/members

Secure
Inherited from Api.listTeamMembers
- Defined in src/v4/generated/Api.ts:7921

listTeams

listTeams(
    workspaceSlug: string,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "name" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<TeamEntityListWrapper>
Parameters
- workspaceSlug: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "name" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<TeamEntityListWrapper>
Description
Returns a paginated list of all Teams in the Workspace.

Name
ListTeams

Request
GET:/api/v4/{workspace-slug}/teams

Secure
Inherited from Api.listTeams
- Defined in src/v4/generated/Api.ts:7724

listTeamStories

listTeamStories(
    workspaceSlug: string,
    teamPublicId: string,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "created_at" | "updated_at" | "position";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<TeamStoryEntityListWrapper>
Parameters
- workspaceSlug: string
- teamPublicId: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "created_at" | "updated_at" | "position";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "created_at" | "updated_at" | "position"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<TeamStoryEntityListWrapper>
Description
Returns a paginated list of all Stories assigned to the specified Team.

Name
ListTeamStories

Request
GET:/api/v4/{workspace-slug}/teams/{team-public-id}/stories

Secure
Inherited from Api.listTeamStories
- Defined in src/v4/generated/Api.ts:7960

listTeamWorkflows

listTeamWorkflows(
    workspaceSlug: string,
    teamPublicId: string,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "name";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<TeamWorkflowEntityListWrapper>
Parameters
- workspaceSlug: string
- teamPublicId: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "name";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<TeamWorkflowEntityListWrapper>
Description
Returns a paginated list of all Workflows for the specified Team.

Name
ListTeamWorkflows

Request
GET:/api/v4/{workspace-slug}/teams/{team-public-id}/workflows

Secure
Inherited from Api.listTeamWorkflows
- Defined in src/v4/generated/Api.ts:7999

listWorkflowProjects

listWorkflowProjects(
    workspaceSlug: string,
    workflowPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<WorkflowProjectEntityListWrapper>
Parameters
- workspaceSlug: string
- workflowPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<WorkflowProjectEntityListWrapper>
Description
Returns a paginated list of all Projects associated with the specified Workflow. Projects are a deprecated feature.

Name
ListWorkflowProjects

Request
GET:/api/v4/{workspace-slug}/workflows/{workflow-public-id}/projects

Deprecated
Secure
Inherited from Api.listWorkflowProjects
- Defined in src/v4/generated/Api.ts:8319

listWorkflows

listWorkflows(
    workspaceSlug: string,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "name";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<WorkflowEntityListWrapper>
Parameters
- workspaceSlug: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "name";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<WorkflowEntityListWrapper>
Description
Returns a paginated list of all Workflows in the Workspace.

Name
ListWorkflows

Request
GET:/api/v4/{workspace-slug}/workflows

Secure
Inherited from Api.listWorkflows
- Defined in src/v4/generated/Api.ts:8139

listWorkflowStates

listWorkflowStates(
    workspaceSlug: string,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "position";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<WorkflowStateEntityListWrapper>
Parameters
- workspaceSlug: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "position";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "position"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<WorkflowStateEntityListWrapper>
Description
Returns a paginated list of all Workflow States in the Workspace.

Name
ListWorkflowStates

Request
GET:/api/v4/{workspace-slug}/workflow-states

Secure
Inherited from Api.listWorkflowStates
- Defined in src/v4/generated/Api.ts:8038

listWorkflowStateStories

listWorkflowStateStories(
    workspaceSlug: string,
    workflowStatePublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "created_at" | "updated_at" | "position";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<WorkflowStoryEntityListWrapper>
Parameters
- workspaceSlug: string
- workflowStatePublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "created_at" | "updated_at" | "position";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "created_at" | "updated_at" | "position"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<WorkflowStoryEntityListWrapper>
Description
Returns a paginated list of all Stories in the specified Workflow State.

Name
ListWorkflowStateStories

Request
GET:/api/v4/{workspace-slug}/workflow-states/{workflow-state-public-id}/stories

Secure
Inherited from Api.listWorkflowStateStories
- Defined in src/v4/generated/Api.ts:8100

listWorkflowStatesWithinAWorkflow

listWorkflowStatesWithinAWorkflow(
    workspaceSlug: string,
    workflowPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "all";
        limit?: number;
        order_by?: "position";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<WorkflowStateEntityListWrapper>
Parameters
- workspaceSlug: string
- workflowPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "all";
      limit?: number;
      order_by?: "position";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "all"
    Filter options (default: :all).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "position"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<WorkflowStateEntityListWrapper>
Description
Returns a paginated list of all Workflow States within the specified Workflow.

Name
ListWorkflowStatesWithinAWorkflow

Request
GET:/api/v4/{workspace-slug}/workflows/{workflow-public-id}/states

Secure
Inherited from Api.listWorkflowStatesWithinAWorkflow
- Defined in src/v4/generated/Api.ts:8240

listWorkflowStories

listWorkflowStories(
    workspaceSlug: string,
    workflowPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "created_at" | "updated_at" | "position";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<WorkflowStoryEntityListWrapper>
Parameters
- workspaceSlug: string
- workflowPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "created_at" | "updated_at" | "position";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "created_at" | "updated_at" | "position"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<WorkflowStoryEntityListWrapper>
Description
Returns a paginated list of all Stories associated with the specified Workflow.

Name
ListWorkflowStories

Request
GET:/api/v4/{workspace-slug}/workflows/{workflow-public-id}/stories

Secure
Inherited from Api.listWorkflowStories
- Defined in src/v4/generated/Api.ts:8279

listWorkflowTeams

listWorkflowTeams(
    workspaceSlug: string,
    workflowPublicId: number,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_archived" | "include_archived";
        limit?: number;
        order_by?: "name" | "updated_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<WorkflowTeamEntityListWrapper>
Parameters
- workspaceSlug: string
- workflowPublicId: number
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_archived" | "include_archived";
      limit?: number;
      order_by?: "name" | "updated_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_archived" | "include_archived"
    Filter options (default: :exclude_archived).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "name" | "updated_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<WorkflowTeamEntityListWrapper>
Description
Returns a paginated list of all Teams associated with the specified Workflow.

Name
ListWorkflowTeams

Request
GET:/api/v4/{workspace-slug}/workflows/{workflow-public-id}/teams

Secure
Inherited from Api.listWorkflowTeams
- Defined in src/v4/generated/Api.ts:8201

listWorkspaceTokens

listWorkspaceTokens(
    workspaceSlug: string,
    query?: {
        cursor?: string;
        fields?: string;
        filter?: "exclude_disabled" | "include_disabled";
        limit?: number;
        order_by?: "created_at";
        order_dir?: "desc" | "asc";
    },
    params?: RequestParams,
): Promise<WorkspaceTokenEntityListWrapper>
Parameters
- workspaceSlug: string
- Optionalquery: {
      cursor?: string;
      fields?: string;
      filter?: "exclude_disabled" | "include_disabled";
      limit?: number;
      order_by?: "created_at";
      order_dir?: "desc" | "asc";
  }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfilter?: "exclude_disabled" | "include_disabled"
    Filter options (default: :exclude_disabled).
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalorder_by?: "created_at"
    Order the results by this property and direction.
  - Optionalorder_dir?: "desc" | "asc"
    Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.
- params: RequestParams = {}
Returns Promise<WorkspaceTokenEntityListWrapper>
Description
List Workspace Tokens returns a paginated list of all API Tokens in the Workspace. Requires admin role.

Name
ListWorkspaceTokens

Request
GET:/api/v4/{workspace-slug}/admin/tokens

Secure
Inherited from Api.listWorkspaceTokens
- Defined in src/v4/generated/Api.ts:282

`Protected`mergeRequestParams

mergeRequestParams(
params1: RequestParams,
params2?: RequestParams,
): RequestParams
Parameters
- params1: RequestParams
- Optionalparams2: RequestParams
Returns RequestParams
Inherited from Api.mergeRequestParams
- Defined in src/v4/generated/http-client.ts:171

nextPage<T>(page: ShortcutV4Page<T>): Promise<ShortcutV4Page<T> | null>
Fetches the page after page by following its next_page_url, or resolves null on the last page. The link is only followed when it points at this client's API origin under /api/v4/ and carries nothing but a cursor and optional fields, so the bearer token never leaves the API.
Type Parameters
- T
Parameters
- page: ShortcutV4Page<T>
Returns Promise<ShortcutV4Page<T> | null>
- Defined in src/v4/ShortcutV4Client.ts:391

paginate

paginate<T>(
first: ShortcutV4Page<T> | Promise<ShortcutV4Page<T>>,
): AsyncGenerator<T, void, undefined>
Iterates every entity across all pages of a list result, following cursors with nextPage. Stops with an error on a repeated cursor, a missing link, or an implausible page count rather than yielding a partial list as if it were complete.
Type Parameters
- T
Parameters
- first: ShortcutV4Page<T> | Promise<ShortcutV4Page<T>>
Returns AsyncGenerator<T, void, undefined>
- Defined in src/v4/ShortcutV4Client.ts:448

removeDocFromCollection

removeDocFromCollection(
    workspaceSlug: string,
    docPublicId: string,
    collectionPublicId: string,
    params?: RequestParams,
): Promise<void>
Parameters
- workspaceSlug: string
- docPublicId: string
- collectionPublicId: string
- params: RequestParams = {}
Returns Promise<void>
Description
Remove Doc from Collection removes the Doc from the chosen Collection, preserving its other Collection memberships. Requires write access to the Doc.

Name
RemoveDocFromCollection

Request
DELETE:/api/v4/{workspace-slug}/documents/{doc-public-id}/collections/{collection-public-id}

Secure
Inherited from Api.removeDocFromCollection
- Defined in src/v4/generated/Api.ts:1481

request

request<T = any, E = any>(__namedParameters: FullRequestParams): Promise<T>
Type Parameters
- T = any
- E = any
Parameters
- __namedParameters: FullRequestParams
Returns Promise<T>
Inherited from Api.request
- Defined in src/v4/generated/http-client.ts:212

search

search(
    workspaceSlug: string,
    query?: {
        cursor?: string;
        entity_types?: string;
        limit?: number;
        query?: string;
    },
    params?: RequestParams,
): Promise<SearchEntitiesOutput>
Parameters
- workspaceSlug: string
- Optionalquery: { cursor?: string; entity_types?: string; limit?: number; query?: string }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalentity_types?: string
    A comma-separated list of entity types to search. Defaults to all supported types. Supported: epic, story, iteration, objective, doc. Docs are only included when the docs feature is enabled for the Workspace.
    
    Min Length
    1
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalquery?: string
    The search query. Required if cursor is not sent. See our help center article on search operators.
    
    Min Length
    1
- params: RequestParams = {}
Returns Promise<SearchEntitiesOutput>
Description
Search lets you search across Epics, Stories, Iterations, Objectives, and Docs with a single query, returning one combined, paginated list of results.

Name
Search

Request
GET:/api/v4/{workspace-slug}/search

Secure
Inherited from Api.search
- Defined in src/v4/generated/Api.ts:5727

searchDocs

searchDocs(
    workspaceSlug: string,
    query?: {
        archived?: boolean;
        created_by_me?: boolean;
        cursor?: string;
        fields?: string;
        followed_by_me?: boolean;
        limit?: number;
        query?: string;
    },
    params?: RequestParams,
): Promise<DocEntityListWrapper>
Parameters
- workspaceSlug: string
- Optionalquery: {
      archived?: boolean;
      created_by_me?: boolean;
      cursor?: string;
      fields?: string;
      followed_by_me?: boolean;
      limit?: number;
      query?: string;
  }
  - Optionalarchived?: boolean
    When true, find archived Docs. When false, find non-archived Docs.
  - Optionalcreated_by_me?: boolean
    When true, find Docs created by the current user. When false, find Docs NOT created by the current user.
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionalfollowed_by_me?: boolean
    When true, find Docs that the current user is following. When false, find Docs NOT followed by the current user.
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalquery?: string
    Search text to match against Doc titles. Supports fuzzy matching. Required if cursor is not sent.
    
    Min Length
    1
- params: RequestParams = {}
Returns Promise<DocEntityListWrapper>
Description
Search Docs lets you search Docs by title, with optional archived/created_by_me/followed_by_me filters.

Name
SearchDocs

Request
GET:/api/v4/{workspace-slug}/documents/search

Secure
Inherited from Api.searchDocs
- Defined in src/v4/generated/Api.ts:1306

searchEpics

searchEpics(
    workspaceSlug: string,
    query?: {
        cursor?: string;
        fields?: string;
        limit?: number;
        query?: string;
    },
    params?: RequestParams,
): Promise<EpicEntityListWrapper>
Parameters
- workspaceSlug: string
- Optionalquery: { cursor?: string; fields?: string; limit?: number; query?: string }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalquery?: string
    The search query. Required if cursor is not sent. See our help center article on search operators.
    
    Min Length
    1
- params: RequestParams = {}
Returns Promise<EpicEntityListWrapper>
Description
Search Epics lets you search Epics based on a query.

Name
SearchEpics

Request
GET:/api/v4/{workspace-slug}/epics/search

Secure
Inherited from Api.searchEpics
- Defined in src/v4/generated/Api.ts:1971

searchIterations

searchIterations(
    workspaceSlug: string,
    query?: {
        cursor?: string;
        fields?: string;
        limit?: number;
        query?: string;
    },
    params?: RequestParams,
): Promise<IterationEntityListWrapper>
Parameters
- workspaceSlug: string
- Optionalquery: { cursor?: string; fields?: string; limit?: number; query?: string }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalquery?: string
    The search query. Required if cursor is not sent. See our help center article on search operators.
    
    Min Length
    1
- params: RequestParams = {}
Returns Promise<IterationEntityListWrapper>
Description
Search Iterations lets you search Iterations based on a query.

Name
SearchIterations

Request
GET:/api/v4/{workspace-slug}/iterations/search

Secure
Inherited from Api.searchIterations
- Defined in src/v4/generated/Api.ts:3284

searchObjectives

searchObjectives(
    workspaceSlug: string,
    query?: {
        cursor?: string;
        fields?: string;
        limit?: number;
        query?: string;
    },
    params?: RequestParams,
): Promise<ObjectiveEntityListWrapper>
Parameters
- workspaceSlug: string
- Optionalquery: { cursor?: string; fields?: string; limit?: number; query?: string }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalquery?: string
    The search query. Required if cursor is not sent. See our help center article on search operators.
    
    Min Length
    1
- params: RequestParams = {}
Returns Promise<ObjectiveEntityListWrapper>
Description
Search Objectives lets you search Objectives based on a query.

Name
SearchObjectives

Request
GET:/api/v4/{workspace-slug}/objectives/search

Secure
Inherited from Api.searchObjectives
- Defined in src/v4/generated/Api.ts:4835

searchStories

searchStories(
    workspaceSlug: string,
    query?: {
        cursor?: string;
        fields?: string;
        limit?: number;
        query?: string;
    },
    params?: RequestParams,
): Promise<StoryEntityListWrapper>
Parameters
- workspaceSlug: string
- Optionalquery: { cursor?: string; fields?: string; limit?: number; query?: string }
  - Optionalcursor?: string
    The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
  - Optionallimit?: number
    The number of results to include in a page. Can be between 1 and 100. Defaults to 10.
    
    Format
    int64
    
    Min
    1
    
    Max
    100
  - Optionalquery?: string
    The search query. Required if cursor is not sent. See our help center article on search operators.
    
    Min Length
    1
- params: RequestParams = {}
Returns Promise<StoryEntityListWrapper>
Description
Search Stories lets you search Stories based on a query.

Name
SearchStories

Request
GET:/api/v4/{workspace-slug}/stories/search

Secure
Inherited from Api.searchStories
- Defined in src/v4/generated/Api.ts:5941

setSecurityData

setSecurityData(data: string | null): void
Parameters
- data: string | null
Returns void
Inherited from Api.setSecurityData
- Defined in src/v4/generated/http-client.ts:100

setToken

setToken(token: string, expiresAt?: string | number | Date): void
Replaces the bearer token, e.g. after an OAuth refresh done outside the client, and records its expiry. Omit expiresAt when it is unknown; the previous expiry does not carry over to a new token.
Parameters
- token: string
- OptionalexpiresAt: string | number | Date
Returns void
- Defined in src/v4/ShortcutV4Client.ts:301

`Protected`toQueryString

toQueryString(rawQuery?: QueryParamsType): string
Parameters
- OptionalrawQuery: QueryParamsType
Returns string
Inherited from Api.toQueryString
- Defined in src/v4/generated/http-client.ts:118

unfavoriteCollection

unfavoriteCollection(
    workspaceSlug: string,
    collectionPublicId: string,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<void>
Parameters
- workspaceSlug: string
- collectionPublicId: string
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<void>
Description
Unfavorite Collection removes the Collection from the current Member's favorites.

Name
UnfavoriteCollection

Request
DELETE:/api/v4/{workspace-slug}/collections/{collection-public-id}/favorite

Secure
Inherited from Api.unfavoriteCollection
- Defined in src/v4/generated/Api.ts:867

updateCategory

updateCategory(
    workspaceSlug: string,
    categoryPublicId: number,
    data: UpdateCategoryParams,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<CategoryEntityWrapper>
Parameters
- workspaceSlug: string
- categoryPublicId: number
- data: UpdateCategoryParams
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<CategoryEntityWrapper>
Description
Update Category allows you to modify a Category in your Shortcut Workspace.

Name
UpdateCategory

Request
PATCH:/api/v4/{workspace-slug}/categories/{category-public-id}

Secure
Inherited from Api.updateCategory
- Defined in src/v4/generated/Api.ts:689

updateCustomField

updateCustomField(
    workspaceSlug: string,
    customFieldPublicId: string,
    data: UpdateCustomFieldParams,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<CustomFieldEntityWrapper>
Parameters
- workspaceSlug: string
- customFieldPublicId: string
- data: UpdateCustomFieldParams
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<CustomFieldEntityWrapper>
Description
Update Custom Field allows you to modify a Custom Field definition in your Shortcut Workspace.

Name
UpdateCustomField

Request
PATCH:/api/v4/{workspace-slug}/custom-fields/{custom-field-public-id}

Secure
Inherited from Api.updateCustomField
- Defined in src/v4/generated/Api.ts:1135

updateEntityTemplate

updateEntityTemplate(
    workspaceSlug: string,
    entityTemplatePublicId: string,
    data: UpdateEntityTemplateParams,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<EntityTemplateEntityWrapper>
Parameters
- workspaceSlug: string
- entityTemplatePublicId: string
- data: UpdateEntityTemplateParams
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<EntityTemplateEntityWrapper>
Description
Update Entity Template updates an existing Entity Template in your Shortcut Workspace.

Name
UpdateEntityTemplate

Request
PATCH:/api/v4/{workspace-slug}/entity-templates/{entity-template-public-id}

Secure
Inherited from Api.updateEntityTemplate
- Defined in src/v4/generated/Api.ts:1711

updateEpic

updateEpic(
    workspaceSlug: string,
    epicPublicId: number,
    data: UpdateEpicParams,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<EpicEntityWrapper>
Parameters
- workspaceSlug: string
- epicPublicId: number
- data: UpdateEpicParams
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<EpicEntityWrapper>
Description
Update Epic is used to modify an Epic in your Shortcut Workspace.

Name
UpdateEpic

Request
PATCH:/api/v4/{workspace-slug}/epics/{epic-public-id}

Secure
Inherited from Api.updateEpic
- Defined in src/v4/generated/Api.ts:2056

updateEpicComment

updateEpicComment(
    workspaceSlug: string,
    epicPublicId: number,
    commentPublicId: number,
    data: UpdateEpicCommentParams,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<EpicCommentEntityWrapper>
Parameters
- workspaceSlug: string
- epicPublicId: number
- commentPublicId: number
- data: UpdateEpicCommentParams
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<EpicCommentEntityWrapper>
Description
Update Epic Comment is used to modify an existing Epic Comment.

Name
UpdateEpicComment

Request
PATCH:/api/v4/{workspace-slug}/epics/{epic-public-id}/comments/{comment-public-id}

Secure
Inherited from Api.updateEpicComment
- Defined in src/v4/generated/Api.ts:2704

updateIteration

updateIteration(
    workspaceSlug: string,
    iterationPublicId: number,
    data: UpdateIterationParams,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<IterationEntityWrapper>
Parameters
- workspaceSlug: string
- iterationPublicId: number
- data: UpdateIterationParams
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<IterationEntityWrapper>
Description
Update Iteration is used to modify an Iteration in your Shortcut Workspace.

Name
UpdateIteration

Request
PATCH:/api/v4/{workspace-slug}/iterations/{iteration-public-id}

Secure
Inherited from Api.updateIteration
- Defined in src/v4/generated/Api.ts:3402

updateKeyResult

updateKeyResult(
    workspaceSlug: string,
    keyResultPublicId: string,
    data: UpdateKeyResultParams,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<KeyResultEntityWrapper>
Parameters
- workspaceSlug: string
- keyResultPublicId: string
- data: UpdateKeyResultParams
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<KeyResultEntityWrapper>
Description
Updates the specified Key Result.

Name
UpdateKeyResult

Request
PUT:/api/v4/{workspace-slug}/key-results/{key-result-public-id}

Secure
Inherited from Api.updateKeyResult
- Defined in src/v4/generated/Api.ts:3764

updateLabel

updateLabel(
    workspaceSlug: string,
    labelPublicId: number,
    data: UpdateLabelParams,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<LabelEntityWrapper>
Parameters
- workspaceSlug: string
- labelPublicId: number
- data: UpdateLabelParams
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<LabelEntityWrapper>
Description
Update Label allows you to modify a Label in your Shortcut Workspace.

Name
UpdateLabel

Request
PATCH:/api/v4/{workspace-slug}/labels/{label-public-id}

Secure
Inherited from Api.updateLabel
- Defined in src/v4/generated/Api.ts:4001

updateLinkedFile

updateLinkedFile(
    workspaceSlug: string,
    linkedFilePublicId: number,
    data: UpdateLinkedFileParams,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<LinkedFileEntityWrapper>
Parameters
- workspaceSlug: string
- linkedFilePublicId: number
- data: UpdateLinkedFileParams
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<LinkedFileEntityWrapper>
Description
Update Linked File is used to update an existing Linked File in your Shortcut Workspace.

Name
UpdateLinkedFile

Request
PATCH:/api/v4/{workspace-slug}/linked-files/{linked-file-public-id}

Secure
Inherited from Api.updateLinkedFile
- Defined in src/v4/generated/Api.ts:4316

updateMember

updateMember(
    workspaceSlug: string,
    memberPublicId: string,
    data: UpdateMemberParams,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<MemberEntityWrapper>
Parameters
- workspaceSlug: string
- memberPublicId: string
- data: UpdateMemberParams
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<MemberEntityWrapper>
Description
Update Member modifies a Member's role or disabled status in the Workspace.

Name
UpdateMember

Request
PATCH:/api/v4/{workspace-slug}/members/{member-public-id}

Secure
Inherited from Api.updateMember
- Defined in src/v4/generated/Api.ts:4563

updateObjective

updateObjective(
    workspaceSlug: string,
    objectivePublicId: number,
    data: UpdateObjectiveParams,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<ObjectiveEntityWrapper>
Parameters
- workspaceSlug: string
- objectivePublicId: number
- data: UpdateObjectiveParams
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<ObjectiveEntityWrapper>
Description
Update Objective is used to modify an Objective in your Shortcut Workspace.

Name
UpdateObjective

Request
PATCH:/api/v4/{workspace-slug}/objectives/{objective-public-id}

Secure
Inherited from Api.updateObjective
- Defined in src/v4/generated/Api.ts:4915

updateProject

updateProject(
    workspaceSlug: string,
    projectPublicId: number,
    data: UpdateProjectParams,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<ProjectEntityWrapper>
Parameters
- workspaceSlug: string
- projectPublicId: number
- data: UpdateProjectParams
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<ProjectEntityWrapper>
Description
Update Project can be used to update Project properties. Projects are a deprecated feature.

Name
UpdateProject

Request
PATCH:/api/v4/{workspace-slug}/projects/{project-public-id}

Deprecated
Secure
Inherited from Api.updateProject
- Defined in src/v4/generated/Api.ts:5340

updateStory

updateStory(
    workspaceSlug: string,
    storyPublicId: number,
    data: UpdateStoryParams,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<StoryEntityWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- data: UpdateStoryParams
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<StoryEntityWrapper>
Description
Update Story is used to modify a Story in your Shortcut Workspace.

Name
UpdateStory

Request
PATCH:/api/v4/{workspace-slug}/stories/{story-public-id}

Secure
Inherited from Api.updateStory
- Defined in src/v4/generated/Api.ts:6062

updateStoryChecklistItem

updateStoryChecklistItem(
    workspaceSlug: string,
    storyPublicId: number,
    checklistItemPublicId: number,
    data: UpdateStoryChecklistItemParams,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<StoryChecklistItemEntityWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- checklistItemPublicId: number
- data: UpdateStoryChecklistItemParams
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<StoryChecklistItemEntityWrapper>
Description
Update Story Checklist Item is used to modify a Checklist Item on a Story.

Name
UpdateStoryChecklistItem

Request
PATCH:/api/v4/{workspace-slug}/stories/{story-public-id}/checklist-items/{checklist-item-public-id}

Secure
Inherited from Api.updateStoryChecklistItem
- Defined in src/v4/generated/Api.ts:7293

updateStoryComment

updateStoryComment(
    workspaceSlug: string,
    storyPublicId: number,
    commentPublicId: number,
    data: UpdateStoryCommentParams,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<StoryCommentEntityWrapper>
Parameters
- workspaceSlug: string
- storyPublicId: number
- commentPublicId: number
- data: UpdateStoryCommentParams
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<StoryCommentEntityWrapper>
Description
Update Story Comment is used to modify a Story Comment.

Name
UpdateStoryComment

Request
PATCH:/api/v4/{workspace-slug}/stories/{story-public-id}/comments/{comment-public-id}

Secure
Inherited from Api.updateStoryComment
- Defined in src/v4/generated/Api.ts:7107

updateStoryLink

updateStoryLink(
    workspaceSlug: string,
    storyLinkPublicId: number,
    data: UpdateStoryLinkBody,
    params?: RequestParams,
): Promise<StoryLinkEntityWrapper>
Parameters
- workspaceSlug: string
- storyLinkPublicId: number
- data: UpdateStoryLinkBody
- params: RequestParams = {}
Returns Promise<StoryLinkEntityWrapper>
Description
Update Story Link is used to modify the stories or verb of an existing Story Link.

Name
UpdateStoryLink

Request
PATCH:/api/v4/{workspace-slug}/story-links/{story-link-public-id}

Secure
Inherited from Api.updateStoryLink
- Defined in src/v4/generated/Api.ts:7702

updateTeam

updateTeam(
    workspaceSlug: string,
    teamPublicId: string,
    data: UpdateTeamParams,
    query?: { fields?: string },
    params?: RequestParams,
): Promise<TeamEntityWrapper>
Parameters
- workspaceSlug: string
- teamPublicId: string
- data: UpdateTeamParams
- Optionalquery: { fields?: string }
  - Optionalfields?: string
    Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.
- params: RequestParams = {}
Returns Promise<TeamEntityWrapper>
Description
Updates the specified Team.

Name
UpdateTeam

Request
PATCH:/api/v4/{workspace-slug}/teams/{team-public-id}

Secure
Inherited from Api.updateTeam
- Defined in src/v4/generated/Api.ts:7894

uploadFiles

uploadFiles(
    workspaceSlug: string,
    data: UploadFilesParams,
    params?: RequestParams,
): Promise<FileEntityListWrapper>
Parameters
- workspaceSlug: string
- data: UploadFilesParams
- params: RequestParams = {}
Returns Promise<FileEntityListWrapper>
Description
Upload Files uploads one or more files and optionally associates them with a Story. Use the multipart/form-data content-type to upload. Each file key should contain a separate file.

Name
UploadFiles

Request
POST:/api/v4/{workspace-slug}/files

Secure
Inherited from Api.uploadFiles
- Defined in src/v4/generated/Api.ts:2915

workspace

workspace(slug: string): ShortcutWorkspaceApi
The API bound to one workspace slug.
Parameters
- slug: string
Returns ShortcutWorkspaceApi
- Defined in src/v4/ShortcutV4Client.ts:359

Class ShortcutV4Client

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ShortcutV4Client

Properties

baseUrl

ReadonlytimeoutMs

Methods

abortRequest

Parameters

Returns void

ProtectedaddArrayQueryParam

Parameters

Returns any

addDocToCollection

Parameters

Optionalfields?: string

Returns Promise<DocEntityWrapper>

Description

Name

Request

Secure

ProtectedaddQueryParam

Parameters

Returns string

ProtectedaddQueryParams

Parameters

Returns string

bulkCreateCategories

Parameters

Optionalcursor?: string

Optionalfields?: string

Optionalfilter?: "exclude_archived" | "include_archived"

Optionallimit?: number

Format

Min

Max

Optionalorder_by?: "name" | "updated_at"

Optionalorder_dir?: "desc" | "asc"

Returns Promise<CategoryEntityListWrapper>

Description

Name

Request

Secure

bulkCreateDocs

Parameters

Optionalcursor?: string

Optionalfields?: string

Optionalfilter?: "exclude_archived" | "include_archived"

Optionallimit?: number

Format

Min

Max

Optionalorder_by?: "created_at" | "updated_at"

Optionalorder_dir?: "desc" | "asc"

Returns Promise<DocEntityListWrapper>

Description

Name

Request

Secure

bulkCreateEntityTemplates

Parameters

Optionalcursor?: string

Optionalfields?: string

Optionalfilter?: "all"

Optionallimit?: number

Format

Min

Max

Optionalorder_by?: "updated_at"

Optionalorder_dir?: "desc" | "asc"

Returns Promise<EntityTemplateEntityListWrapper>

Description

Name

`Readonly`timeoutMs

`Protected`addArrayQueryParam

`Optional`fields?: string

`Protected`addQueryParam

`Protected`addQueryParams

`Optional`cursor?: string

`Optional`fields?: string

`Optional`filter?: "exclude_archived" | "include_archived"

`Optional`limit?: number

`Optional`order_by?: "name" | "updated_at"

`Optional`order_dir?: "desc" | "asc"

`Optional`cursor?: string

`Optional`fields?: string

`Optional`filter?: "exclude_archived" | "include_archived"

`Optional`limit?: number

`Optional`order_by?: "created_at" | "updated_at"

`Optional`order_dir?: "desc" | "asc"

`Optional`cursor?: string

`Optional`fields?: string

`Optional`filter?: "all"

`Optional`limit?: number

`Optional`order_by?: "updated_at"

`Optional`order_dir?: "desc" | "asc"

`Optional`cursor?: string

`Optional`fields?: string

`Optional`filter?: "all"

`Optional`limit?: number

`Optional`order_by?: "created_at" | "updated_at"

`Optional`order_dir?: "desc" | "asc"

`Optional`cursor?: string

`Optional`fields?: string

`Optional`filter?: "exclude_archived" | "include_archived"

`Optional`limit?: number

`Optional`order_by?: "updated_at"

`Optional`order_dir?: "desc" | "asc"

`Optional`cursor?: string

`Optional`fields?: string

`Optional`filter?: "all"

`Optional`limit?: number

`Optional`order_by?: "updated_at" | "start_date"

`Optional`order_dir?: "desc" | "asc"

`Optional`cursor?: string

`Optional`fields?: string

`Optional`filter?: "exclude_archived" | "include_archived"

`Optional`limit?: number

`Optional`order_by?: "name" | "created_at" | "updated_at"

`Optional`order_dir?: "desc" | "asc"

`Optional`cursor?: string

`Optional`fields?: string