List Works (POST)

POST

Lists a collection of work items.

Request

This endpoint expects an object.
actual_close_dateobjectRequired

Provides ways to specify date ranges on objects.

created_dateobjectRequired

Provides ways to specify date ranges on objects.

issueobjectRequired
modeenumRequired
Allowed values: afterbefore

The iteration mode to use. If “after”, then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If “before”, then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.

modified_dateobjectRequired

Provides ways to specify date ranges on objects.

stageobjectRequired

The filter for stages.

staged_infoobjectRequired
sync_metadataobjectRequired
target_close_dateobjectRequired

Provides ways to specify date ranges on objects.

ticketobjectRequired
typelist of enumsOptional
Allowed values: issueticket

Filters for work of the provided types.

applies_to_partlist of stringsOptional

Filters for work belonging to any of the provided parts.

created_bylist of stringsOptional

Filters for work created by any of these users.

cursorstringOptional

The cursor to resume iteration from. If not provided, then iteration starts from the beginning.

limitintegerOptional

The maximum number of works to return. The default is ‘50’.

owned_bylist of stringsOptional

Filters for work owned by any of these users.

reported_bylist of stringsOptional

Filters for work reported by any of these users.

statelist of stringsOptional

Filters for work with any of the provided states.

tagslist of stringsOptional

Filters for work with any of the provided tags.

Response

Success.

workslist of objects

The list of works.

next_cursorstringOptional

The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.

prev_cursorstringOptional

The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

Built with