Beta
Search...
/
About
For Developers
API Reference
accounts
articles
artifacts
auth-tokens
code-changes
notifications
conversations
auth-connection
dev-users
engagements
event-source
groups
operate
keyring
links
slas
product-usage
schedules
parts
question-answers
rev-orgs
rev-users
customization
search
service-accounts
snap-ins
snap-widgets
surveys
sys-users
tags
timeline-entries
webhooks
works
POST
Create
POST
Delete
GET
Export
POST
Export Post
GET
Get
POST
Get Post
GET
List
POST
List Post
POST
Update
Guides
Object Customization
Create accounts and contacts in DevRev
API Reference
works
List
GET
https://
api.devrev.ai
/
works.list
Lists a collection of work items.
Query parameters
applies_to_part
string
Optional
Filters for work belonging to any of the provided parts.
created_by
string
Optional
Filters for work created by any of these users.
cursor
string
Optional
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
custom_fields
map from strings to any
Optional
Filters for custom fields.
issue.accounts
string
Optional
Filters for issues with any of the provided Accounts.
issue.priority
enum
Optional
Filters for issues with any of the provided priorities.
Allowed values:
p0
p1
p2
p3
issue.priority_v2
long
Optional
Filters for issues with any of the provided priority enum ids.
issue.rev_orgs
string
Optional
Filters for issues with any of the provided Rev organizations.
issue.sla_summary.stage
enum
Optional
Filters for records with any of the provided SLA stages.
Allowed values:
breached
completed
paused
running
warning
issue.sprint
string
Optional
Filters for issues with any of the sprint.
issue.subtype
string
Optional
Filters for issues with any of the provided subtypes.
limit
integer
Optional
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:
after
before
opportunity.account
string
Optional
Filters for opportunities belonging to any of the provided accounts.
opportunity.contacts
string
Optional
Filters for opportunities with any of the provided contacts.
opportunity.subtype
string
Optional
Filters for opportunity with any of the provided subtypes.
owned_by
string
Optional
Filters for work owned by any of these users.
reported_by
string
Optional
Filters for work reported by any of these users.
sort_by
string
Optional
Fields to sort the works by and the direction to sort them.
stage.name
string
Optional
Filters for records in the provided stage(s) by name.
staged_info.is_staged
boolean
Optional
Filters for issues that are staged.
sync_metadata.external_reference
string
Optional
Filters for issues with this specific external reference.
sync_metadata.last_sync_in.status
enum
Optional
Filters for works with selected sync statuses.
Allowed values:
failed
modified
staged
succeeded
sync_metadata.last_sync_in.sync_unit
string
Optional
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:
failed
succeeded
sync_metadata.last_sync_out.sync_unit
string
Optional
Filters for works modified with selected sync units.
sync_metadata.origin_system
string
Optional
Filters for issues synced from this specific origin system.
tags
string
Optional
Filters for work with any of the provided tags.
ticket.channels
enum
Optional
Filters for tickets with any of the provided channels.
Allowed values:
email
plug
slack
twilio
twilio_sms
ticket.group
string
Optional
Filters for tickets belonging to specific groups.
ticket.is_spam
boolean
Optional
Filters for tickets that are spam.
ticket.needs_response
boolean
Optional
Filters for tickets that need response.
ticket.rev_org
string
Optional
Filters for tickets that are associated with any of the provided Rev organizations.
ticket.severity
enum
Optional
Filters for tickets with any of the provided severities.
Allowed values:
blocker
high
low
medium
ticket.sla_summary.stage
enum
Optional
Filters for records with any of the provided SLA stages.
Allowed values:
breached
completed
paused
running
warning
ticket.source_channel
string
Optional
Filters for tickets with any of the provided source channels.
ticket.subtype
string
Optional
Filters for tickets with any of the provided subtypes.
type
enum
Optional
Filters for work of the provided types.
Allowed values:
issue
opportunity
task
ticket
Response
This endpoint returns an object.
works
list of objects
The list of works.
Show 4 variants
next_cursor
string
Optional
The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.
prev_cursor
string
Optional
The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.
Built with