Qodex.ai

List subject access requests

GET {{baseUrl}}/api/v1/subjectAccessRequests

This API lists a particular number of subject access requests, based on the limit specified.

OAuth Scope

  • Desk.settings.READ

Request Params

KeyDatatypeRequiredDescription
fromstringIndex number, starting from which the requests must be fetched.
limitstringNumber of requests to list. The default value is 10 and the maximum value supported is 100.
contactEmailIdstringEmail ID of the contact who made the request.
statusstringProcessing status of the request. Values allowed are: INITIATED, INPROGRESS, COMPLETED, CANCELED, EXPORTED, PARTIALLY_COMPLETED, PARTIALLY_EXPORTED and FAILED. You can pass multiple values by separating them using commas in the API request.
durationstringPeriod in which the requests were made. Values allowed are: TODAY, LAST_24_HOURS, LAST_7_DAYS, LAST_30_DAYS, CURRENT_WEEK, and CURRENT_MONTH.
startTimestringStarting time of the time range in which the requests should have been created. The time should be in the UTC time zone and expressed in a timestamp.
endTimestringEnding time of the time range in which the requests should have been created. The time should be in the UTC time zone and expressed in a timestamp.
requestTypestringFilter by type of the request. Values allowed are: ACCESS_REQUEST, ERASURE_REQUEST. You can pass multiple values by separating them using commas in the API request.
includestringAdditional information related to the requests. Values allowed are: createdBy and modifiedBy. You can pass multiple values by separating them using commas in the API request.

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"data":[{"referencereferenceTicketNumber":"105","contactEmailId":"john@zylker.com","modifiedById":"7000000000247","createdBy":{"photoURL":"https://desk.zoho.com/api/v1/agents/7000000000247/photo?orgId=15273347","firstName":"Jack","lastName":"Carol","id":"7000000000247","email":"jack@zylker.com"},"sarNumber":"141","createdTime":"2020-10-29T12:11:51.890Z","modifiedBy":{"photoURL":"https://desk.zoho.com/api/v1/agents/7000000000247/photo?orgId=15273347","firstName":"Jack","lastName":"Carol","id":"7000000000247","email":"jack@zylker.com"},"id":"7000000092437","createdById":"7000000000247","status":"COMPLETED"},{"contactEmailId":"nirmal@zylker.com","modifiedById":"7000000000247","createdBy":{"photoURL":"https://desk.zoho.com/api/v1/agents/7000000000247/photo?orgId=15273347","firstName":"Jack","lastName":"Carol","id":"7000000000247","email":"jack@zylker.com"},"referenceTicketNumber":null,"sarNumber":"140","createdTime":"2020-10-29T12:10:16.890Z","modifiedBy":{"photoURL":"https://desk.zoho.com/api/v1/agents/7000000000247/photo?orgId=15273347","firstName":"Jack","lastName":"Carol","id":"7000000000247","email":"jack@zylker.com"},"id":"7000000092243","createdById":"7000000000247","status":"INITIATED"},{"contactEmailId":"mark@zylker.com","modifiedById":"7000000000247","createdBy":{"photoURL":"https://desk.zoho.com/api/v1/agents/7000000000247/photo?orgId=15273347","firstName":"Jack","lastName":"Carol","id":"7000000000247","email":"jack@zylker.com"},"referenceTicketNumber":"102","sarNumber":"139","createdTime":"2020-10-29T12:08:18.838Z","modifiedBy":{"photoURL":"https://desk.zoho.com/api/v1/agents/7000000000247/photo?orgId=15273347","firstName":"Jack","lastName":"Carol","id":"7000000000247","email":"jack@zylker.com"},"id":"7000000092049","createdById":"7000000000247","status":"INPROGRESS"},{"contactEmailId":"john@zylker.com","modifiedById":"7000000000247","createdBy":{"photoURL":"https://desk.zoho.com/api/v1/agents/7000000000247/photo?orgId=15273347","firstName":"Jack","lastName":"Carol","id":"7000000000247","email":"jack@zylker.com"},"referenceTicketNumber":null,"sarNumber":"138","createdTime":"2020-10-29T12:02:29.954Z","modifiedBy":{"photoURL":"https://desk.zoho.com/api/v1/agents/7000000000247/photo?orgId=15273347","firstName":"Jack","lastName":"Carol","id":"7000000000247","email":"jack@zylker.com"},"id":"7000000091353","createdById":"7000000000247","status":"INPROGRESS"},{"contactEmailId":"mark@zylker.com","modifiedById":"7000000000247","createdBy":{"photoURL":"https://desk.zoho.com/api/v1/agents/7000000000247/photo?orgId=15273347","firstName":"Jack","lastName":"Carol","id":"7000000000247","email":"jack@zylker.com"},"referenceTicketNumber":null,"sarNumber":"137","createdTime":"2020-10-29T11:59:26.592Z","modifiedBy":{"photoURL":"https://desk.zoho.com/api/v1/agents/7000000000247/photo?orgId=15273347","firstName":"Jack","lastName":"Carol","id":"7000000000247","email":"jack@zylker.com"},"id":"7000000091159","createdById":"7000000000247","status":"INITIATED"}]}