Qodex.ai

List deleted resources

GET {{baseUrl}}/v1/recycleBin

This API lists a particular number of deleted resources, based on the limit specified.

OAuth Scope

  • Desk.settings.READ

Request Params

KeyDatatypeRequiredDescription
fromstringIndex number, starting from which the resources must be fetched.
limitstringNumber of resources to list. The default value is 10 and the maximum value supported is 100.
departmentIdstringID of the department to which the deleted resources belong.
sortBystringSort by a specific attribute: name, type, department, deletedBy, or deletedTime. The default sorting order is ascending. A - prefix denotes descending order of sorting.
includestringAdditional information related to the resources. Values allowed are: department and deletedBy. You can pass multiple values by separating them with commas in the API request.
modulestringFilter by a specific module: accounts, contacts, tickets, tasks, timeEntry, calls, events, contracts, products, topics, or solutions

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"data":[{"displayName":"Sample display name","departmentId":null,"deletedById":"4000000000059","id":"4000000046163","type":"Attachments","deletedTime":"2020-06-21T16:16:16.000Z"},{"displayName":"Sample display name","departmentId":"4000000013244","deletedById":"4000000000059","id":"4000000046093","type":"Calls","deletedTime":"2020-06-21T16:16:16.000Z"},{"displayName":"Sample display name","departmentId":"4000000013244","deletedById":"4000000000059","id":"4000000017184","type":"Tickets","deletedTime":"2020-06-21T16:16:16.000Z"},{"displayName":"Sample display name","departmentId":"4000000013244","deletedById":"4000000000059","id":"4000000046029","type":"Tickets","deletedTime":"2020-06-21T16:16:16.000Z"},{"displayName":"Sample display name","departmentId":null,"deletedById":"4000000000059","id":"4000000019005","type":"Contacts","deletedTime":"2020-06-21T16:16:16.000Z"},{"displayName":"Sample display name","departmentId":"4000000013244","deletedById":"4000000000059","id":"4000000046131","type":"Events","deletedTime":"2020-06-21T16:16:16.000Z"},{"displayName":"Sample display name","departmentId":"4000000013244","deletedById":"4000000000059","id":"4000000046111","type":"Tasks","deletedTime":"2020-06-21T16:16:16.000Z"},{"displayName":"Sample display name","departmentId":"4000000013244","deletedById":"4000000000059","id":"4000000046153","type":"Time Entry","deletedTime":"2020-06-21T16:16:16.000Z"}]}