• About
    • For Developers
    • Authentication
    • Pagination
    • Versioning
    • Rate Limits
    • Errors
  • API Reference
    • Getting started
    • Changelog
  • Guides
    • Webhooks
    • Restricted messages on a timeline
    • Object customization
    • Custom objects
  • SDKs
    • Push notifications for mobile
  • Snap-in development
    • Concepts
    • Development best practices
    • Locally testing snap-ins
    • Handling errors and retrying
    • Debugging
    • Quotas and limits
    • Upgrade snap-ins
    • Code Samples
    • Marketplace listings
  • AirSync
    • Getting started
    • Examples of snap-ins
    • Deploy to organization
    • Publish to the marketplace
    • MCP integration
    • Common issues
    • Supported DevRev object types
LogoLogo
API Referenceworks

Export Works

GET
https://api.devrev.ai/works.export
GET
/works.export
1curl https://api.devrev.ai/works.export \
2     -H "Authorization: Bearer <token>"
Try it
200Retrieved
1{
2  "works": [
3    {
4      "created_by": {
5        "display_id": "string",
6        "id": "string",
7        "display_name": "string",
8        "display_picture": {
9          "display_id": "string",
10          "id": "string",
11          "file": {
12            "type": "string",
13            "name": "string",
14            "size": 1
15          }
16        },
17        "email": "string",
18        "full_name": "string",
19        "state": "active"
20      },
21      "created_date": "2023-01-01T12:00:00.000Z",
22      "display_id": "string",
23      "id": "string",
24      "modified_by": {
25        "display_id": "string",
26        "id": "string",
27        "display_name": "string",
28        "display_picture": {
29          "display_id": "string",
30          "id": "string",
31          "file": {
32            "type": "string",
33            "name": "string",
34            "size": 1
35          }
36        },
37        "email": "string",
38        "full_name": "string",
39        "state": "active"
40      },
41      "modified_date": "2023-01-01T12:00:00.000Z",
42      "applies_to_part": {
43        "display_id": "string",
44        "id": "string",
45        "name": "string",
46        "owned_by": [
47          {
48            "display_id": {},
49            "id": {},
50            "display_name": {},
51            "display_picture": {},
52            "email": {},
53            "full_name": {},
54            "state": {}
55          }
56        ]
57      },
58      "artifacts": [
59        {
60          "display_id": "string",
61          "id": "string",
62          "file": {
63            "type": "string",
64            "name": "string",
65            "size": 1
66          }
67        }
68      ],
69      "body": "string",
70      "owned_by": [
71        {
72          "display_id": "string",
73          "id": "string",
74          "display_name": "string",
75          "display_picture": {
76            "display_id": "string",
77            "id": "string",
78            "file": {
79              "type": "string",
80              "name": "string",
81              "size": 1
82            }
83          },
84          "email": "string",
85          "full_name": "string",
86          "state": "active"
87        }
88      ],
89      "reported_by": [
90        {
91          "display_id": "string",
92          "id": "string",
93          "display_name": "string",
94          "display_picture": {
95            "display_id": "string",
96            "id": "string",
97            "file": {
98              "type": "string",
99              "name": "string",
100              "size": 1
101            }
102          },
103          "email": "string",
104          "full_name": "string",
105          "state": "active"
106        }
107      ],
108      "stage": {
109        "name": "string"
110      },
111      "tags": [
112        {
113          "tag": {
114            "display_id": "string",
115            "id": "string",
116            "name": "string"
117          },
118          "value": "string"
119        }
120      ],
121      "target_close_date": "2023-01-01T12:00:00.000Z",
122      "title": "string",
123      "developed_with": [
124        {
125          "display_id": "string",
126          "id": "string",
127          "name": "string",
128          "owned_by": [
129            {
130              "display_id": "string",
131              "id": "string",
132              "display_name": "string",
133              "display_picture": {},
134              "email": "string",
135              "full_name": "string",
136              "state": "active"
137            }
138          ]
139        }
140      ],
141      "estimated_effort": 1.1,
142      "priority": "p0",
143      "priority_v2": {
144        "id": 1,
145        "label": "string",
146        "ordinal": 1,
147        "value": null
148      },
149      "sla_summary": {
150        "closest_to_breach_metric": "string",
151        "org_schedule": {
152          "display_id": "string",
153          "id": "string",
154          "name": "string",
155          "status": "archived",
156          "timezone": "string",
157          "valid_until": "2023-01-01T12:00:00.000Z"
158        },
159        "remaining_time": 1,
160        "sla_tracker": {
161          "created_by": {
162            "display_id": "string",
163            "id": "string",
164            "display_name": "string",
165            "display_picture": {
166              "display_id": {},
167              "id": {},
168              "file": {}
169            },
170            "email": "string",
171            "full_name": "string",
172            "state": "active"
173          },
174          "created_date": "2023-01-01T12:00:00.000Z",
175          "display_id": "string",
176          "id": "string",
177          "modified_by": {
178            "display_id": "string",
179            "id": "string",
180            "display_name": "string",
181            "display_picture": {
182              "display_id": {},
183              "id": {},
184              "file": {}
185            },
186            "email": "string",
187            "full_name": "string",
188            "state": "active"
189          },
190          "modified_date": "2023-01-01T12:00:00.000Z",
191          "applies_to_id": "string",
192          "applies_to_type": "conversation",
193          "metric_target_summaries": [
194            {
195              "breached_at": "2023-01-01T12:00:00.000Z",
196              "completed_at": "2023-01-01T12:00:00.000Z",
197              "completed_in": 1,
198              "in_policy": true,
199              "is_out_of_schedule": true,
200              "metric_definition": {
201                "display_id": "string",
202                "id": "string",
203                "name": "string"
204              },
205              "next_schedule_transition": "2023-01-01T12:00:00.000Z",
206              "org_schedule": {
207                "display_id": "string",
208                "id": "string",
209                "name": "string",
210                "status": "archived",
211                "timezone": "string",
212                "valid_until": "2023-01-01T12:00:00.000Z"
213              },
214              "remaining_time": 1,
215              "stage": "string",
216              "status": "string",
217              "target_time": "2023-01-01T12:00:00.000Z",
218              "warning_target_time": "2023-01-01T12:00:00.000Z"
219            }
220          ],
221          "removed_sla_metric_history": [
222            {}
223          ],
224          "sla": {
225            "display_id": "string",
226            "id": "string",
227            "name": "string",
228            "sla_type": "external",
229            "status": "archived"
230          },
231          "sla_policy_id": "string",
232          "stage": "string",
233          "status": "string"
234        },
235        "stage": "breached",
236        "target_time": "2023-01-01T12:00:00.000Z"
237      },
238      "sla_tracker": {
239        "display_id": "string",
240        "id": "string",
241        "applies_to_type": "conversation"
242      },
243      "sprint": {
244        "type": "curated",
245        "end_date": "2023-01-01T12:00:00.000Z",
246        "id": "string",
247        "name": "string",
248        "start_date": "2023-01-01T12:00:00.000Z",
249        "state": "active"
250      },
251      "target_start_date": "2023-01-01T12:00:00.000Z"
252    }
253  ]
254}
Exports a collection of work items.
Was this page helpful?
Previous

Export Works (POST)

Next
Built with
Exports a collection of work items.

Authentication

AuthorizationBearer
Bearer authentication of the form `Bearer <token>`, where token is your auth token.

Query parameters

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.
firstintegerOptional
Filters for work belonging to any of the provided parts.
Filters for work created by any of these users.

Bearer authentication of the form Bearer <token>, where token is your auth token.

The number of work items to return. The default is '50', the maximum is '5000'.
issue.accountslist of stringsOptional
Filters for issues with any of the provided accounts.
issue.prioritylist of enumsOptional
Filters for issues with any of the provided priorities.
Allowed values:
issue.priority_v2list of longsOptional
Filters for issues with any of the provided priority enum ids.
issue.rev_orgslist of stringsOptional
Filters for issues with any of the provided Rev organizations.
issue.sla_summary.stagelist of enumsOptional
Filters for records with any of the provided SLA stages.
Allowed values:
issue.sprintlist of stringsOptional
Filters for issues with any of the sprint.
modified_bylist of stringsOptional
Filters for work modified by any of these users.
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.
stage.namelist of stringsOptional
Filters for records in the provided stage(s) by name.
staged_info.is_stagedbooleanOptional
Filters for issues that are staged.
statelist of stringsOptional
Filters for work with any of the provided states.
sync_metadata.external_referencelist of stringsOptional
Filters for issues with this specific external reference.
sync_metadata.last_sync_in.statuslist of enumsOptional
Filters for works with selected sync statuses.
Allowed values:
sync_metadata.last_sync_in.sync_historylist of stringsOptional
Filters for works modified with selected sync history.
sync_metadata.last_sync_in.sync_unitlist of stringsOptional
Filters for works modified with selected sync units.
sync_metadata.last_sync_out.statuslist of enumsOptional
Filters for works with selected sync statuses.
Allowed values:
sync_metadata.last_sync_out.sync_historylist of stringsOptional
Filters for works modified with selected sync history.
sync_metadata.last_sync_out.sync_unitlist of stringsOptional
Filters for works modified with selected sync units.
sync_metadata.origin_systemlist of stringsOptional
Filters for issues synced from this specific origin system.
tagslist of stringsOptional
Filters for work with any of the provided tags.
ticket.brandlist of stringsOptional
Filters for tickets that are associated with any of the brands.
ticket.channelslist of enumsOptional
Filters for tickets with any of the provided channels.
Allowed values:
ticket.channels_v2list of stringsOptional
Filters for tickets that are associated with any of the channels.
ticket.grouplist of stringsOptional
Filters for tickets belonging to specific groups.
ticket.is_frozenbooleanOptional
Filters for frozen tickets.
ticket.is_spambooleanOptional
Filters for tickets that are spam.
ticket.needs_responsebooleanOptional
Filters for tickets that need response.
ticket.rev_orglist of stringsOptional
Filters for tickets that are associated with any of the provided Rev organizations.
ticket.severitylist of enumsOptional
Filters for tickets with any of the provided severities.
Allowed values:
ticket.sla_summary.stagelist of enumsOptional
Filters for records with any of the provided SLA stages.
Allowed values:
ticket.source_channellist of stringsOptional
Filters for tickets with any of the provided source channels.
ticket.source_channel_v2list of stringsOptional
Filters for tickets that are associated with any of the source channels.
typelist of enumsOptional
Filters for work of the provided types.
Allowed values:

Response

Success.
workslist of objects
The resulting collection of work items.

Errors

Export Works (POST)

Filters for records in the provided stage(s) by name.