API Guide

Get Complaint Sample

The Get Complaint Sample endpoint provides the available HTML, text, and headers from a complaint. Data is returned in the following formats: XML, JSON, CSV and Serialized.

Required headers: X-API-KEY
Optional headers: ACCEPT (json, xml, csv, serialized)
Method: GET

Endpoint URL:


Sample Output:

        "html": "<!DOCTYPE html>...",
        "text": "Hello World,\r\n",
        "headers": "DKIM-Signature: a=rsa..."


Parameter Description Acceptable Values Required
id The complaint identifier ('messagesample_id' field) provided by Get Complaints String Y

Error Responses

Description Code Cause
You must specify a complaint ID. 404 A complaint ID was not detected in the request.
No results found. 404 We couldn't find any results matching your criteria.