Suped

Get started

Welcome to the Suped HTTP REST API. All responses are JSON formatted.
Reach out to contact@suped.com for an API key that will give you access to all of your organizations.
Our philosophy for building this API is to improve it on an "as needed" basis. If you need anything that our API does not provide, contact us (contact@suped.com) and we will work with you to get it right. Don't worry, we move fast!

Authentication

After you have reached out for an API key, just include it in each request's headers:
Authorization: Bearer <key>
For example, as a curl flag:
curl --header 'Authorization: Bearer 23983fj03249tj3240gj09asjd0f94j032f409j90f34'

Response codes

200: Success, returns data.
400: Bad request, check your query parameters, we will include a message explaining why.
403: Forbidden, check your API key is set correctly/you have access to the included organization ID.
404: Invalid URL, check the path.
429: Rate limit hit, we won't implement rate limits yet but expect this in the future.
500: A bug on our end, let us know.

Endpoint: GET /dmarc-records

URL
Request should be made to:
https://www.suped.com/api/public/dmarc-records
With query parameters appended on the end, see below
Query parameters
organizationId: Go to the organization's dashboard in Suped and you can pull the ID from the URL
startDate: Will only return reports whose reported date is after or equal to this date. This is an ISO8601 string.
endDate: Will only return reports whose reported date is before or equal to this date. This is an ISO8601 string.
Response
Always returns JSON:
{ status: "success", dmarcRecords: Record[], }
Each record represents a single row from a DMARC report. I.e a DMARC report would include many records.
// Individual Record. Returns an array of these. type Record = { source: string; // The source Suped detected reporter: string; // Who sent this DMARC report to Suped from: string; // User visible domain returnPath: string; // Return-Path domain ipAddress: string; // IP address of the original sender // Reverse DNS lookup of ipAddress. // Will usually contain exactly 1 entry. // Will sometimes contain zero entries for poorly configured sending sources. // Will very rarely contain multiple entries, but it is possible for multiple // values to exist for an RDNS record. rdns: string; emails: number; // How many emails does this row represent category: "authorized" | "rejected" | "quarantined" | "partially-authorized", date: string; // ISO8601 dmarc: "none" | "quarantine" | "reject"; // "none" means the email was delivered. alignedSpf: Result; // See below alignedDkim: Result; // See below spf: Result; // See below // An email can include multiple DKIM signatures. Contains 1 element per: dkims: { selector: string; domain: string; result: Result; // See below }[]; };
// Result for SPF/DKIM type Result = "permerror" | "fail" | "temperror" | "softfail" | "unknown" | "none" | "neutral" | "policy" | "pass" | ""
Example request (Javascript)
fetch("https://www.suped.com/api/public/dmarc-records?organizationId=68958a04833ee738476e12d4&startDate=2025-08-12T05:51:21.267Z&endDate=2025-09-12T05:51:21.267Z", { method: "GET", headers: { "Authorization": "Bearer 23983fj03249tj3240gj09asjd0f94j032f409j90f34" }, }
Example request (curl)
curl 'https://www.suped.com/api/public/dmarc-records?organizationId=68958a04833ee738476e12d4&startDate=2025-08-12T05:51:21.267Z&endDate=2025-09-12T05:51:21.267Z' \ --header 'Authorization: Bearer 23983fj03249tj3240gj09asjd0f94j032f409j90f34'
Example response (JSON)
[ { "source": "Gmail", "reporter": "Outlook", "from": "suped.com", "returnPath": "mail.suped.com", "ipAddress": "127.0.0.1", "rdns": [ "gmail-outbound.gmail.com" ], "emails": 12345, "category": "authorized", "date": "2025-10-08T07:17:31.012Z", "dmarc": "none", "alignedSpf": "fail", "alignedDkim": "fail", "spf": "fail", "dkims": [ { "selector": "s1", "domain": "suped.com", "result": "fail" }, { "selector": "g", "domain": "gmail.com", "result": "pass" } ] }, { "source": "Gmail", "reporter": "Outlook", "from": "suped.com", "returnPath": "mail.suped.com", "ipAddress": "127.0.0.1", "rdns": [ "gmail-outbound.gmail.com" ], "emails": 12345, "category": "authorized", "date": "2025-10-08T07:17:31.012Z", "dmarc": "none", "alignedSpf": "fail", "alignedDkim": "fail", "spf": "fail", "dkims": [ { "selector": "s1", "domain": "suped.com", "result": "fail" }, { "selector": "g", "domain": "gmail.com", "result": "pass" } ] } ]