List Epic Comments

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.

get/api/v4/{workspace-slug}/epics/{epic-public-id}/comments

Request

  • Base URL: https://api.app.shortcut.com
  • URL: https://api.app.shortcut.com/api/v4/{workspace-slug}/epics/{epic-public-id}/comments
  • Auth: HTTP bearer

Path parameters

workspace-slugstring required

The slug for the Workspace.

epic-public-idinteger required

The ID of the Epic.

Query parameters

fieldsstring

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.

order_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.

idsstring

A comma-separated list of ids. If included, only those entities will be considered for listing.

limitinteger

The number of results to include in a page. Can be between 1 and 100. Defaults to 10.

order_by'updated_at' | 'created_at'

Order the results by this property and direction.

filter'all'

Filter options (default: :all).

cursorstring

The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.

Response

Resource

$schemastring required

The URI for the json-schema for this response.

current_itemsinteger required

The number of items on the current page.

current_pageinteger required

The number of the current page.

total_itemsinteger required

The number of total items across all pages.

total_pagesinteger required

The total number of pages.

next_page_urlstring

A URL to get the next page. Will be absent on the last page.

Changes

No recorded changes to this operation across all 1 revision of this API.