GDPR GET Request

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Authentication

This request can be authenticated by providing your Company Private Token either as a query parameter (parameter name: token) OR in the request header (parameter name: X-Token)

Optional Parameters

The customer for whom personal information and message data is being requested must be identified by one of the following parameters.

  1. phone_number
  2. external_id
  3. email
  4. customer_id

Delivery of requested data

Personal information and message data is provided in one of two ways depending on whether the request includes a destination_email.

If a destination_email is provided, personal information and message data are delivered via email, to the email address provided in the destination_email parameter. The email will contain hyperlinks the recipient can click to download the data.

If a destination_email is not provided, personal information and message data are delivered in the HTTP response body in JSON format.

Query Params
string

Optional. See Authentication section above

string

Optional

string

Optional. Customer ID from a system external to Sonar

string

Optional. Customer email

string

Optional. The public id of a customer found. Public id can be obtained from the response to a GET Customer request or from custom webhook payloads

string

Optional. The email address where personal information and message data will be sent in .csv format. If destination_email is omitted from the request, data is provided in the response body

Headers
string

Optional. See Authentication section above

Responses

Language
Credentials
LoadingLoading…
Response
Choose an example:
application/json