List

GET
Lists a collection of work items.

Query parameters

applies_to_partstringOptional
Filters for work belonging to any of the provided parts.
created_bystringOptional
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.
custom_fieldsmap from strings to anyOptional
Filters for custom fields.
issue.accountsstringOptional
Filters for issues with any of the provided Accounts.
issue.priorityenumOptional
Filters for issues with any of the provided priorities.
Allowed values: p0p1p2p3
issue.priority_v2longOptional
Filters for issues with any of the provided priority enum ids.
issue.rev_orgsstringOptional
Filters for issues with any of the provided Rev organizations.
issue.sla_summary.stageenumOptional
Filters for records with any of the provided SLA stages.
Allowed values: breachedcompletedpausedrunningwarning
issue.sprintstringOptional
Filters for issues with any of the sprint.
issue.subtypestringOptional
Filters for issues with any of the provided subtypes.
limitintegerOptional
The maximum number of works to return. The default is '50'.
mode"after" or "before"Optional
The iteration mode to use, otherwise if not set, then "after" is used.
Allowed values: afterbefore
opportunity.accountstringOptional
Filters for opportunities belonging to any of the provided accounts.
opportunity.contactsstringOptional
Filters for opportunities with any of the provided contacts.
opportunity.subtypestringOptional
Filters for opportunity with any of the provided subtypes.
owned_bystringOptional
Filters for work owned by any of these users.
reported_bystringOptional
Filters for work reported by any of these users.
sort_bystringOptional
Fields to sort the works by and the direction to sort them.
stage.namestringOptional
Filters for records in the provided stage(s) by name.
staged_info.is_stagedbooleanOptional
Filters for issues that are staged.
sync_metadata.external_referencestringOptional
Filters for issues with this specific external reference.
sync_metadata.last_sync_in.statusenumOptional
Filters for works with selected sync statuses.
Allowed values: failedmodifiedstagedsucceeded
sync_metadata.last_sync_in.sync_unitstringOptional
Filters for works modified with selected sync units.
sync_metadata.last_sync_out.status"failed" or "succeeded"Optional
Filters for works with selected sync statuses.
Allowed values: failedsucceeded
sync_metadata.last_sync_out.sync_unitstringOptional
Filters for works modified with selected sync units.
sync_metadata.origin_systemstringOptional
Filters for issues synced from this specific origin system.
tagsstringOptional
Filters for work with any of the provided tags.
ticket.channelsenumOptional
Filters for tickets with any of the provided channels.
Allowed values: emailplugslacktwiliotwilio_sms
ticket.groupstringOptional
Filters for tickets belonging to specific groups.
ticket.is_spambooleanOptional
Filters for tickets that are spam.
ticket.needs_responsebooleanOptional
Filters for tickets that need response.
ticket.rev_orgstringOptional
Filters for tickets that are associated with any of the provided Rev organizations.
ticket.severityenumOptional
Filters for tickets with any of the provided severities.
Allowed values: blockerhighlowmedium
ticket.sla_summary.stageenumOptional
Filters for records with any of the provided SLA stages.
Allowed values: breachedcompletedpausedrunningwarning
ticket.source_channelstringOptional
Filters for tickets with any of the provided source channels.
ticket.subtypestringOptional
Filters for tickets with any of the provided subtypes.
typeenumOptional
Filters for work of the provided types.
Allowed values: issueopportunitytaskticket

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