Get subject access request

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

This API fetches the details of a particular SAR.

OAuth Scope

  • Desk.settings.READ

Request Params

KeyDatatypeRequiredDescription
includestringAdditional information related to the request. 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

{"contactEmailId":"carrol@zylker.com","requestType":"ERASURE_REQUEST","recordType":"SPECIFIC","module":"tickets","query":{"criteriaFields":[{"condition":"is before","field":{"apiName":"createdTime","fieldLabel":"Created Time"},"value":{"primitive":[{"displayKey":"${CURRENTTIME}","key":"${CURRENTTIME}"}],"type":"primitive"}}],"criteriaPattern":"1"},"downloadURL":null,"modifiedById":"7000000000247","createdBy":{"photoURL":"https://desk.zoho.com/api/v1/agents/7000000000247/photo?orgId=15273347","firstName":"Nirmal","lastName":"Kumar","id":"7000000000247","email":"nirmal@zylker.com"},"referenceTicketNumber":null,"sarNumber":"141","createdTime":"2020-10-29T12:11:51.890Z","modifiedBy":{"photoURL":"https://desk.zoho.com/api/v1/agents/7000000000247/photo?orgId=15273347","firstName":"Nirmal","lastName":"Kumar","id":"7000000000247","email":"john@zylker.com"},"id":"7000000092437","createdById":"7000000000247","status":"INPROGRESS"}