List Post

POST
Lists a collection of work items.

Request

This endpoint expects an object.
typelist of "issue" or "ticket"Optional
Allowed values: issueticket
Filters for work of the provided types.
actual_close_dateobjectOptional
Provides ways to specify date ranges on objects.
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.
created_dateobjectOptional
Provides ways to specify date ranges on objects.
cursorstringOptional
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
issueobjectOptional
limitintegerOptional
The maximum number of works to return. The default is '50'.
mode"after" or "before"Optional
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_dateobjectOptional
Provides ways to specify date ranges on objects.
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.
stageobjectOptional
The filter for stages.
staged_infoobjectOptional
sync_metadataobjectOptional
tagslist of stringsOptional
Filters for work with any of the provided tags.
target_close_dateobjectOptional
Provides ways to specify date ranges on objects.
ticketobjectOptional

Response

This endpoint returns an object
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