works

List Post

POST
Lists a collection of work items.

Request

This endpoint expects an object.
actual_close_date
unionOptional
Provides ways to specify date ranges on objects.
applies_to_part
list of stringsOptional
Filters for work belonging to any of the provided parts.
created_by
list of stringsOptional
Filters for work created by any of these users.
created_date
unionOptional
Provides ways to specify date ranges on objects.
cursor
stringOptional
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
custom_fields
map from strings to anyOptional
Filters for custom fields.
issue
objectOptional
limit
integerOptional
The maximum number of works to return. The default is '50'.
mode
enumOptional
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.
Allowed values: afterbefore
modified_date
unionOptional
Provides ways to specify date ranges on objects.
opportunity
objectOptional
owned_by
list of stringsOptional
Filters for work owned by any of these users.
reported_by
list of stringsOptional
Filters for work reported by any of these users.
sort_by
list of stringsOptional
Fields to sort the works by and the direction to sort them.
stage
objectOptional
The filter for stages.
staged_info
objectOptional
sync_metadata
objectOptional
tags
list of stringsOptional
Filters for work with any of the provided tags.
target_close_date
unionOptional
Provides ways to specify date ranges on objects.
ticket
objectOptional
type
list of enumsOptional
Filters for work of the provided types.
Allowed values: issueopportunitytaskticket

Response

This endpoint returns an object
works
list of unions
The list of works.
next_cursor
stringOptional
The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.
prev_cursor
stringOptional
The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.
POST
1curl -X POST https://api.devrev.ai/works.list \
2 -H "Authorization: <apiKey>" \
3 -H "Content-Type: application/json" \
4 -d '{}'
200Successful
1{
2 "works": [],
3 "next_cursor": "next_cursor",
4 "prev_cursor": "prev_cursor"
5}