{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/postmasterplus.app" } ], "info": { "name": "Postmaster+ API Documentation", "_postman_id": "a2226c52-03e8-48a3-9d9a-7e4e39557611", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Domains", "description": "", "item": [ { "name": "Retrieve Domains.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/domains", "query": [ { "key": "page", "value": "1", "description": "The page number. Must be at least 1.", "disabled": false }, { "key": "per_page", "value": "15", "description": "The number of domains per page. Must be at least 1. Must not be greater than 100.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/domains?page=1&per_page=15" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"message\":\"Domains retrieved successfully.\",\"data\":[{\"id\":\"01ARZ3NDEKTSV4RRFFQ69G5FAV\",\"value\":\"example.com\",\"description\":\"Primary sending domain\",\"created_at\":\"2026-03-28T10:30:00.000000Z\",\"updated_at\":\"2026-03-28T10:30:00.000000Z\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"per_page\":15,\"to\":1,\"total\":1}}", "name": "" } ] }, { "name": "Retrieve Domain Feed.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/domains\/:id\/feed", "query": [ { "key": "page", "value": "1", "description": "The page number for paginated feed results. Must be at least 1.", "disabled": false }, { "key": "date", "value": "2026-08-06", "description": "Filter feed items reported on or after this date, up to today. Must not be older than 90 days from today. Must be a valid date in the format Y-m-d.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/domains\/:id\/feed?page=1&date=2026-08-06", "variable": [ { "id": "id", "key": "id", "value": "01ARZ3NDEKTSV4RRFFQ69G5FAV", "description": "The ULID of the domain." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Domain feed retrieved successfully.\",\n \"data\": [\n {\n \"reported_at\": \"Mar 28, 2026 5:30PM\",\n \"mail_stream\": \"Transactional Stream\",\n \"domain\": {\n \"id\": \"01ARZ3NDEKTSV4RRFFQ69G5FAV\",\n \"value\": \"example.com\",\n \"description\": \"Primary sending domain\",\n \"created_at\": \"2026-03-28T10:30:00.000000Z\",\n \"updated_at\": \"2026-03-28T10:30:00.000000Z\"\n },\n \"spf_domain\": \"example.com\",\n \"seed_message\": {\n \"mail_from_name\": \"Test Sender\",\n \"mail_from\": \"sender@example.com\",\n \"subject\": \"Seed message\",\n \"preview_line\": \"This is a preview.\",\n \"is_compliant\": true,\n \"is_blocklisted\": false,\n \"is_test\": false\n }\n },\n {\n \"message\": \"SPF is valid.\",\n \"reported_at\": \"Mar 28, 2026 4:45PM\",\n \"mail_stream\": \"Transactional Stream\",\n \"domain\": {\n \"id\": \"01ARZ3NDEKTSV4RRFFQ69G5FAV\",\n \"value\": \"example.com\",\n \"description\": \"Primary sending domain\",\n \"created_at\": \"2026-03-28T10:30:00.000000Z\",\n \"updated_at\": \"2026-03-28T10:30:00.000000Z\"\n },\n \"spf_domain\": null,\n \"seed_message\": null\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 2,\n \"per_page\": 15,\n \"to\": 15,\n \"total\": 16\n }\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"message\": \"Feed is only available for activated domains.\",\n \"data\": []\n}", "name": "" } ] }, { "name": "Retrieve Domain.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/domains\/:id", "query": [ { "key": "start_date", "value": "2026-01-01", "description": "Filter related IPs from this date (Y-m-d). Maximum selected range is 90 days.", "disabled": false }, { "key": "end_date", "value": "2026-03-31", "description": "Filter related IPs until this date (Y-m-d). Maximum selected range is 90 days.", "disabled": false }, { "key": "related_ips_page", "value": "1", "description": "The page number for related IP results.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/domains\/:id?start_date=2026-01-01&end_date=2026-03-31&related_ips_page=1", "variable": [ { "id": "id", "key": "id", "value": "01ARZ3NDEKTSV4RRFFQ69G5FAV", "description": "The ULID of the domain." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"related_ips_page\":16,\"start_date\":\"2022-08-31\",\"end_date\":\"2052-08-29\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"message\":\"Domain retrieved successfully.\",\"data\":{\"id\":\"01ARZ3NDEKTSV4RRFFQ69G5FAV\",\"value\":\"example.com\",\"description\":\"Primary sending domain\",\"created_at\":\"2026-03-28T10:30:00.000000Z\",\"updated_at\":\"2026-03-28T10:30:00.000000Z\",\"logo\":null,\"team\":{\"name\":\"Owner Custom Team\"},\"mail_streams\":[{\"name\":\"Transactional Stream\",\"type\":\"transactional\",\"logo\":\"https:\\\/\\\/cdn.example.com\\\/mail-streams\\\/transactional.svg\"}],\"configuration\":{\"spf_domains\":[],\"dkim_selectors\":[],\"bimi_selectors\":[],\"dmarc\":{\"valid\":true,\"record\":\"v=DMARC1; p=none;\"},\"mx\":{\"valid\":true,\"records\":[\"mx1.example.com\",\"mx2.example.com\"]},\"created_at\":\"2026-03-28T10:30:00.000000Z\",\"updated_at\":\"2026-03-28T10:30:00.000000Z\"},\"alignment\":{\"items\":[]},\"settings\":{\"estimated_message_volume\":\"1000\",\"general_settings\":{\"estimated_message_volume\":\"1000\"},\"shared_team_ids\":[],\"mail_streams\":[{\"name\":\"Transactional Stream\",\"type\":\"transactional\",\"general_settings\":[]}],\"spf_domains\":[]},\"compliance\":{\"is_compliant\":true,\"pre_send\":{\"is_compliant\":true,\"mail_streams\":[{\"name\":\"Transactional Stream\",\"type\":\"transactional\",\"is_compliant\":true,\"checks\":{\"ips\":true,\"one_click_unsub\":false,\"blocklists\":true,\"spf\":true,\"dkim\":true,\"dmarc\":true,\"tls\":true}}]},\"post_send\":{\"is_compliant\":false,\"requirements\":{\"spf\":true,\"dkim\":null,\"dmarc_alignment\":null,\"dmarc_policy\":false,\"encryption\":null,\"user_reported_spam_rate\":null,\"dns_records\":null,\"one_click_unsubscribe\":null,\"honor_unsubscribe\":null,\"message_formatting\":null},\"subdomain\":{\"domain_id\":\"mail.example.com\",\"requirements\":{\"spf\":false,\"dkim\":false,\"dmarc_alignment\":null,\"dmarc_policy\":null,\"encryption\":null,\"user_reported_spam_rate\":null,\"dns_records\":null,\"one_click_unsubscribe\":null,\"honor_unsubscribe\":null,\"message_formatting\":null}}},\"mail_streams\":[{\"name\":\"Transactional Stream\",\"type\":\"transactional\",\"is_compliant\":true,\"checks\":{\"ips\":true,\"one_click_unsub\":false,\"blocklists\":true,\"spf\":true,\"dkim\":true,\"dmarc\":true,\"tls\":true}}]},\"complaint_rate_averages\":{\"periods\":[]},\"related_ips\":{\"date_range\":{\"start_date\":\"2026-01-01 00:00:00\",\"end_date\":\"2026-03-31 23:59:59\"},\"items\":[{\"id\":\"01ARZ3NDEKTSV4RRFFQ69G5FAV\",\"value\":\"192.0.2.10\",\"description\":\"Primary sending IP\",\"created_at\":\"2026-03-28T10:30:00.000000Z\",\"updated_at\":\"2026-03-28T10:30:00.000000Z\"}],\"meta\":{\"current_page\":1,\"last_page\":1,\"per_page\":10,\"total\":0}},\"blocklists\":{\"is_blacklist\":false,\"blacklist_count\":0,\"listed_count\":0,\"listed_muted\":0,\"listed_details\":[]}}}", "name": "" } ] } ] }, { "name": "APRF", "description": "", "item": [ { "name": "Retrieve APRF Reports.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/aprf-reports", "query": [ { "key": "domain_id", "value": "01ARZ3NDEKTSV4RRFFQ69G5FAV", "description": "Optionally filter reports to a single accessible domain ULID. Rollups and reports for untracked domains carry no domain, so this filter excludes them.", "disabled": false }, { "key": "start_date", "value": "2026-05-09", "description": "Filter reports whose report_date falls on or after this date (Y-m-d). Maximum selected range is 90 days. Defaults to the trailing 90 days.", "disabled": false }, { "key": "end_date", "value": "2026-08-06", "description": "Filter reports whose report_date falls on or before this date (Y-m-d). Maximum selected range is 90 days.", "disabled": false }, { "key": "sort", "value": "report_date", "description": "Sort field. Either a report column (report_date, report_end, source, dkim_selector) or a single metric bucket as metric:.. Reports without the sorted metric are always ordered last.", "disabled": false }, { "key": "direction", "value": "desc", "description": "Sort direction, asc or desc.", "disabled": false }, { "key": "page", "value": "1", "description": "The page number for paginated report results.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Reports per page. Defaults to 25 and is clamped to a maximum of 100.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/aprf-reports?domain_id=01ARZ3NDEKTSV4RRFFQ69G5FAV&start_date=2026-05-09&end_date=2026-08-06&sort=report_date&direction=desc&page=1&per_page=25" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List the Comcast\/Xfinity APRF (Aggregate Postmaster Report Feedback) reports\nreceived for this team in the given date range.\n\nThe collection is team-wide rather than nested under a domain on purpose:\na provider may send a rollup covering several domains or selectors, or a\nreport for a domain this team does not track, and both must stay reachable.\nThose reports carry `domain: null` and are never attributed to a tracked\ndomain by name.\n\nMetric values are provider-supplied approximate bucket upper bounds. They\nare not counts, so they must not be summed, averaged or turned into\npercentages; `metric_value_semantics` repeats that on every response." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"message\":\"APRF reports retrieved successfully.\",\"data\":[{\"id\":1421,\"domain\":{\"id\":\"01ARZ3NDEKTSV4RRFFQ69G5FAV\",\"value\":\"example.com\"},\"is_rollup\":false,\"source\":\"Comcast\\\/Xfinity\",\"dkim_domain\":\"example.com\",\"dkim_selector\":\"s1\",\"report_start\":\"2026-08-04T00:00:00+00:00\",\"report_end\":\"2026-08-04T23:59:59+00:00\",\"report_date\":\"2026-08-04\",\"sender_verified\":true,\"billing\":{\"status\":\"charged\",\"is_billed\":true,\"withheld_reason\":null,\"credits_used\":1},\"metrics\":[{\"category\":\"classification\",\"metric_key\":\"inbox\",\"approximate_bucket_upper_bound\":25}]},{\"id\":1420,\"domain\":null,\"is_rollup\":true,\"source\":\"Comcast\\\/Xfinity\",\"dkim_domain\":\"*.example.com\",\"dkim_selector\":\"*\",\"report_start\":\"2026-08-03T00:00:00+00:00\",\"report_end\":\"2026-08-03T23:59:59+00:00\",\"report_date\":\"2026-08-03\",\"sender_verified\":false,\"billing\":{\"status\":\"not_billable\",\"is_billed\":false,\"withheld_reason\":null,\"credits_used\":0},\"metrics\":[]}],\"meta\":{\"current_page\":1,\"last_page\":1,\"per_page\":25,\"total\":2},\"date_range\":{\"start_date\":\"2026-05-09\",\"end_date\":\"2026-08-06\"},\"sort\":{\"field\":\"report_date\",\"direction\":\"desc\"},\"metric_value_semantics\":\"provider_bucket_upper_bound_non_additive\"}", "name": "" } ] }, { "name": "Retrieve APRF Report.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/aprf-reports\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/aprf-reports\/:id", "variable": [ { "id": "id", "key": "id", "value": 1421, "description": "The APRF report identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return one APRF report and its unsegmented metrics. Segmented metric rows\ndescribe slices of a report and would double-count, so they are never\nexposed.\n\nA report belonging to another team, a report we were never able to charge\nfor, and an identifier that does not exist all answer the same 404, so the\nresponse never reveals which case it was.\n\nThe id is typed as a string because `whereNumber` admits a value past bigint\nthat an int parameter would fail to coerce, answering 500 instead of the\nusual 404." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"message\":\"APRF report retrieved successfully.\",\"data\":{\"id\":1421,\"domain\":{\"id\":\"01ARZ3NDEKTSV4RRFFQ69G5FAV\",\"value\":\"example.com\"},\"is_rollup\":false,\"source\":\"Comcast\\\/Xfinity\",\"dkim_domain\":\"example.com\",\"dkim_selector\":\"s1\",\"report_start\":\"2026-08-04T00:00:00+00:00\",\"report_end\":\"2026-08-04T23:59:59+00:00\",\"report_date\":\"2026-08-04\",\"sender_verified\":true,\"billing\":{\"status\":\"charged\",\"is_billed\":true,\"withheld_reason\":null,\"credits_used\":1},\"metrics\":[{\"category\":\"classification\",\"metric_key\":\"inbox\",\"approximate_bucket_upper_bound\":25}]},\"metric_value_semantics\":\"provider_bucket_upper_bound_non_additive\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"success\":false,\"message\":\"APRF report not found.\",\"data\":[]}", "name": "" } ] }, { "name": "Retrieve Domain APRF Status.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/domains\/:id\/aprf-status", "query": [], "raw": "{{baseUrl}}\/api\/v1\/domains\/:id\/aprf-status", "variable": [ { "id": "id", "key": "id", "value": "01ARZ3NDEKTSV4RRFFQ69G5FAV", "description": "The ULID of the domain." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return the stored APRF (Aggregate Postmaster Report Feedback) DNS and\nconsent snapshot for one domain, plus the DNS records to publish so this\nteam receives reports for it.\n\nThis is a snapshot, never a live lookup: every record, verdict and message\nis what we last observed, and `checked_at` is the only indicator of how\nfresh that is. A stale `checked_at` means our snapshot is old, not that DNS\nchanged. There is no refresh parameter.\n\n`has_our_seed_address` is the one derived value. Selector records are shared\nbetween the teams that track the same domain, so the verdict cannot be\nstored against the record; it is computed per request from the requesting\nteam's own report address.\n\nThe response carries no metrics, so it carries no `metric_value_semantics`." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"message\":\"APRF status retrieved successfully.\",\"data\":{\"domain\":{\"id\":\"01ARZ3NDEKTSV4RRFFQ69G5FAV\",\"value\":\"example.com\"},\"report_address\":\"seed@a-abc123.seed.example.com\",\"wildcard\":{\"record\":\"v=APRFv1; rua=mailto:seed@a-abc123.seed.example.com\",\"valid\":true,\"message\":\"APRF record is valid.\",\"source\":\"wildcard\",\"has_our_seed_address\":true,\"checked_at\":\"2026-08-05T09:00:00+00:00\"},\"selectors\":[{\"selector\":\"s1\",\"record\":\"v=APRFv1; rua=mailto:seed@a-abc123.seed.example.com\",\"valid\":true,\"message\":\"APRF record is valid.\",\"source\":\"selector\",\"has_our_seed_address\":true,\"checked_at\":\"2026-08-05T09:00:00+00:00\"}],\"sdi\":{\"header\":\"MsgInfo\",\"separator\":\"^\"},\"recommended_records\":[{\"name\":\"*._aprf._domainkey.example.com\",\"type\":\"TXT\",\"value\":\"v=APRFv1; rua=mailto:seed@a-abc123.seed.example.com; sdi=MsgInfo,^\",\"scope\":\"wildcard\",\"selector\":null},{\"name\":\"s1._aprf._domainkey.example.com\",\"type\":\"TXT\",\"value\":\"v=APRFv1; rua=mailto:seed@a-abc123.seed.example.com; sdi=MsgInfo,^\",\"scope\":\"selector\",\"selector\":\"s1\"}]}}", "name": "" } ] }, { "name": "Update Domain APRF SDI.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/domains\/:id\/aprf-sdi", "query": [], "raw": "{{baseUrl}}\/api\/v1\/domains\/:id\/aprf-sdi", "variable": [ { "id": "id", "key": "id", "value": "01ARZ3NDEKTSV4RRFFQ69G5FAV", "description": "The ULID of the domain. Must be owned by this team; a domain only shared with it is not found here." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"aprf_sdi_header\":\"MsgInfo\",\"aprf_sdi_separator\":\"^\"}" }, "description": "Set or clear the optional Sender Defined Identifier pair for one domain.\nBoth fields must be sent: a header with a separator sets the pair, and two\nnulls clear it. One without the other is a 422, because a half-configured\npair cannot be written into a record.\n\nThis changes the records the domain owner must publish. The SDI pair is\nappended to every recommended record as `sdi=
,`, so a\nrecord published before this call no longer matches the recommendation\nafterwards. The response is the full status payload for exactly that\nreason: read `recommended_records` back and re-publish from it.\n\nNothing about the stored DNS snapshot changes here. No lookup is performed,\nevery `checked_at` is untouched, and the domain does not begin or stop\nreceiving reports because of this call.\n\nUnlike the read endpoint, this resolves the domain by owning team only. A\ndomain merely shared with this team is a 404 here: the SDI pair decides what\nits owner has to publish, so a team it was shared with must not rewrite it." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"message\":\"APRF SDI updated successfully.\",\"data\":{\"domain\":{\"id\":\"01ARZ3NDEKTSV4RRFFQ69G5FAV\",\"value\":\"example.com\"},\"report_address\":\"seed@a-abc123.seed.example.com\",\"wildcard\":{\"record\":\"v=APRFv1; rua=mailto:seed@a-abc123.seed.example.com\",\"valid\":true,\"message\":\"APRF record is valid.\",\"source\":\"wildcard\",\"has_our_seed_address\":true,\"checked_at\":\"2026-08-05T09:00:00+00:00\"},\"selectors\":[],\"sdi\":{\"header\":\"MsgInfo\",\"separator\":\"^\"},\"recommended_records\":[{\"name\":\"*._aprf._domainkey.example.com\",\"type\":\"TXT\",\"value\":\"v=APRFv1; rua=mailto:seed@a-abc123.seed.example.com; sdi=MsgInfo,^\",\"scope\":\"wildcard\",\"selector\":null}]}}", "name": "" } ] } ] }, { "name": "IPs", "description": "", "item": [ { "name": "Retrieve IPs.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ips", "query": [ { "key": "page", "value": "1", "description": "The page number. Must be at least 1.", "disabled": false }, { "key": "per_page", "value": "15", "description": "The number of IPs per page. Must be at least 1. Must not be greater than 100.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/ips?page=1&per_page=15" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"message\":\"IPs retrieved successfully.\",\"data\":[{\"id\":\"01ARZ3NDEKTSV4RRFFQ69G5FAV\",\"value\":\"192.0.2.10\",\"description\":\"Primary sending IP\",\"created_at\":\"2026-03-28T10:30:00.000000Z\",\"updated_at\":\"2026-03-28T10:30:00.000000Z\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"per_page\":15,\"to\":1,\"total\":1}}", "name": "" } ] }, { "name": "Retrieve IP Feed.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ips\/:id\/feed", "query": [ { "key": "page", "value": "1", "description": "The page number for paginated feed results. Must be at least 1.", "disabled": false }, { "key": "date", "value": "2026-08-06", "description": "Filter feed items reported on or after this date, up to today. Must not be older than 90 days from today. Must be a valid date in the format Y-m-d.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/ips\/:id\/feed?page=1&date=2026-08-06", "variable": [ { "id": "id", "key": "id", "value": "01ARZ3NDEKTSV4RRFFQ69G5FAV", "description": "The ULID of the IP." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"IP feed retrieved successfully.\",\n \"data\": [\n {\n \"reported_at\": \"Mar 28, 2026 5:30PM\",\n \"mail_stream\": \"Transactional Stream\",\n \"ip\": {\n \"id\": \"01ARZ3NDEKTSV4RRFFQ69G5FAV\",\n \"value\": \"192.0.2.10\",\n \"description\": \"Primary sending IP\",\n \"created_at\": \"2026-03-28T10:30:00.000000Z\",\n \"updated_at\": \"2026-03-28T10:30:00.000000Z\"\n },\n \"seed_message\": {\n \"mail_from_name\": \"Test Sender\",\n \"mail_from\": \"sender@example.com\",\n \"subject\": \"Seed message\",\n \"preview_line\": \"This is a preview.\",\n \"is_compliant\": true,\n \"is_blocklisted\": false,\n \"is_test\": false\n }\n },\n {\n \"message\": \"IP is compliant.\",\n \"reported_at\": \"Mar 28, 2026 4:45PM\",\n \"mail_stream\": \"Transactional Stream\",\n \"ip\": {\n \"id\": \"01ARZ3NDEKTSV4RRFFQ69G5FAV\",\n \"value\": \"192.0.2.10\",\n \"description\": \"Primary sending IP\",\n \"created_at\": \"2026-03-28T10:30:00.000000Z\",\n \"updated_at\": \"2026-03-28T10:30:00.000000Z\"\n },\n \"seed_message\": null\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 2,\n \"per_page\": 15,\n \"to\": 15,\n \"total\": 16\n }\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"message\": \"Feed is only available for activated IPs.\",\n \"data\": []\n}", "name": "" } ] }, { "name": "Retrieve IP.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ips\/:id", "query": [ { "key": "start_date", "value": "2026-01-01", "description": "Filter related domains from this date (Y-m-d). Maximum selected range is 90 days.", "disabled": false }, { "key": "end_date", "value": "2026-03-31", "description": "Filter related domains until this date (Y-m-d). Maximum selected range is 90 days.", "disabled": false }, { "key": "related_domains_page", "value": "1", "description": "The page number for related domain results.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/ips\/:id?start_date=2026-01-01&end_date=2026-03-31&related_domains_page=1", "variable": [ { "id": "id", "key": "id", "value": "01ARZ3NDEKTSV4RRFFQ69G5FAV", "description": "The ULID of the IP." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"related_domains_page\":16,\"start_date\":\"2022-08-31\",\"end_date\":\"2052-08-29\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"message\":\"IP retrieved successfully.\",\"data\":{\"id\":\"01ARZ3NDEKTSV4RRFFQ69G5FAV\",\"value\":\"192.0.2.10\",\"description\":\"Primary sending IP\",\"created_at\":\"2026-03-28T10:30:00.000000Z\",\"updated_at\":\"2026-03-28T10:30:00.000000Z\",\"logo\":null,\"team\":{\"name\":\"Owner Custom Team\"},\"mail_streams\":[{\"name\":\"Transactional Stream\",\"type\":\"transactional\",\"logo\":\"https:\\\/\\\/cdn.example.com\\\/mail-streams\\\/transactional.svg\"}],\"configuration\":{\"rdns\":\"mail.example.com\",\"fcrdns\":true,\"rdns_summary\":null,\"provider\":{\"asn\":{\"asn\":\"AS64500\",\"name\":\"Example ASN\"},\"location\":\"37.7749,-122.4194\"},\"created_at\":\"2026-03-28T10:30:00.000000Z\",\"updated_at\":\"2026-03-28T10:30:00.000000Z\"},\"settings\":{\"shared_team_ids\":[]},\"compliance\":{\"is_compliant\":true,\"sender_score\":98,\"checks\":{\"blocklists\":true,\"fcrdns\":true}},\"complaint_rate_averages\":{\"periods\":[]},\"inbox_placement_averages\":{\"periods\":[]},\"related_domains\":{\"date_range\":{\"start_date\":\"2026-01-01 00:00:00\",\"end_date\":\"2026-03-31 23:59:59\"},\"items\":[{\"id\":\"01ARZ3NDEKTSV4RRFFQ69G5FAV\",\"value\":\"example.com\",\"description\":\"Primary sending domain\",\"created_at\":\"2026-03-28T10:30:00.000000Z\",\"updated_at\":\"2026-03-28T10:30:00.000000Z\"}],\"meta\":{\"current_page\":1,\"last_page\":1,\"per_page\":10,\"total\":0}},\"blocklists\":{\"is_blacklist\":false,\"blacklist_count\":0,\"listed_count\":0,\"listed_muted\":0,\"listed_details\":[]}}}", "name": "" } ] } ] }, { "name": "Intelligence", "description": "", "item": [ { "name": "Single Email", "description": "", "item": [ { "name": "Retrieve Single Email.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/intelligence\/single-emails\/:email", "query": [], "raw": "{{baseUrl}}\/api\/v1\/intelligence\/single-emails\/:email", "variable": [ { "id": "email", "key": "email", "value": "example@postmasterplus.com", "description": "The email address to retrieve." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":11,\"email\":\"price.amber@example.org\",\"status\":null,\"created_at\":\"2026-08-06 14:24:38\",\"updated_at\":\"2026-08-06 14:24:38\"}}", "name": "" } ] }, { "name": "Scan Single Email.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/intelligence\/single-emails\/scan", "query": [], "raw": "{{baseUrl}}\/api\/v1\/intelligence\/single-emails\/scan" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"example@postmasterplus.com\",\"actions\":\"\\\"verification,activity,postal_append\\\"\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":12,\"email\":\"rempel.chadrick@example.org\",\"status\":null,\"created_at\":\"2026-08-06 14:24:38\",\"updated_at\":\"2026-08-06 14:24:38\"}}", "name": "" } ] }, { "name": "Delete Single Email.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/intelligence\/single-emails\/:email", "query": [], "raw": "{{baseUrl}}\/api\/v1\/intelligence\/single-emails\/:email", "variable": [ { "id": "email", "key": "email", "value": "example@postmasterplus.com", "description": "The email address to delete." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"message\": \"Single email deleted.\", \"deleted\": true}", "name": "" } ] } ] } ] }, { "name": "Blocklists", "description": "", "item": [ { "name": "Blocklist Scan", "description": "", "item": [ { "name": "Start Blocklist Scan.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/blocklist\/scan\/start", "query": [], "raw": "{{baseUrl}}\/api\/v1\/blocklist\/scan\/start" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"urls\":[\"https:\\\/\\\/optipub.com\\\/newsletter\",\"optipub.com\",\"8.8.8.8\"],\"follow_redirects\":true}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"01kzbqcfbr82g17w8vcqgfqn8h\",\"status\":\"pending\",\"status_label\":\"Pending\",\"unique_hosts_checked\":3,\"total_hosts_detected\":null,\"urls_scanned\":0,\"urls_skipped\":0,\"blocklisted\":false,\"credits_used\":0,\"error_message\":\"\",\"started_at\":null,\"completed_at\":null},\"success\":true,\"message\":\"Blocklist check started successfully.\"}", "name": "" } ] }, { "name": "Retrieve Blocklist Scan Status.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/blocklist\/scan\/status\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/blocklist\/scan\/status\/:id", "variable": [ { "id": "id", "key": "id", "value": "01ARZ3NDEKTSV4RRFFQ69G5FAV", "description": "The ULID of the blocklist check." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"01kzbqcfc62awwsmrkkc7qn50r\",\"status\":\"pending\",\"status_label\":\"Pending\",\"unique_hosts_checked\":4,\"total_hosts_detected\":null,\"urls_scanned\":0,\"urls_skipped\":0,\"blocklisted\":false,\"credits_used\":0,\"error_message\":\"\",\"started_at\":null,\"completed_at\":null},\"success\":true,\"message\":\"Blocklist check status retrieved successfully.\"}", "name": "" } ] } ] } ] }, { "name": "Seedbox", "description": "", "item": [ { "name": "GET api\/v1\/seedboxes", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/seedboxes", "query": [], "raw": "{{baseUrl}}\/api\/v1\/seedboxes" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"status\":\"active\",\"client_reference\":\"b\",\"per_page\":22,\"page\":67}" }, "description": "" }, "response": [] }, { "name": "POST api\/v1\/seedboxes", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/seedboxes", "query": [], "raw": "{{baseUrl}}\/api\/v1\/seedboxes" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"client_reference\":\"n\",\"scan_blocklists\":true}" }, "description": "" }, "response": [] }, { "name": "GET api\/v1\/seedboxes\/{seedbox}\/messages", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/seedboxes\/:seedbox\/messages", "query": [], "raw": "{{baseUrl}}\/api\/v1\/seedboxes\/:seedbox\/messages", "variable": [ { "id": "seedbox", "key": "seedbox", "value": "58C6f7nnFCJ9M6rjyc6rTKMzn6", "description": "The seedbox." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"per_page\":1,\"page\":22,\"include_content\":\"true\"}" }, "description": "" }, "response": [] }, { "name": "GET api\/v1\/seedboxes\/{seedbox}\/messages\/{message}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/seedboxes\/:seedbox\/messages\/:message", "query": [], "raw": "{{baseUrl}}\/api\/v1\/seedboxes\/:seedbox\/messages\/:message", "variable": [ { "id": "seedbox", "key": "seedbox", "value": "58C6f7nnFCJ9M6rjyc6rTKMzn6", "description": "The seedbox." }, { "id": "message", "key": "message", "value": "BcECdBDA-CdED-bFEA-CbCE-BcCdeBfbbebc", "description": "The message." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"include_content\":\"1\"}" }, "description": "" }, "response": [] }, { "name": "Request a one-click unsubscribe for the list behind a seedbox message.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/seedboxes\/:seedbox\/messages\/:message\/unsubscribe", "query": [], "raw": "{{baseUrl}}\/api\/v1\/seedboxes\/:seedbox\/messages\/:message\/unsubscribe", "variable": [ { "id": "seedbox", "key": "seedbox", "value": "58C6f7nnFCJ9M6rjyc6rTKMzn6", "description": "The seedbox." }, { "id": "message", "key": "message", "value": "BcECdBDA-CdED-bFEA-CbCE-BcCdeBfbbebc", "description": "The message." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Mirrors the web endpoint exactly: this action owns no unsubscribe logic\nof its own, it resolves the message through the current team, delegates\nto the shared action, and maps the returned outcome to a status through\n{@see RequestUnsubscribeOutcome}, so every surface agrees on whether an\noutcome counts as a success. A `rate_limited` outcome answers 429 and the same\nrequest may succeed once the budget refills." }, "response": [] }, { "name": "GET api\/v1\/seedboxes\/{seedbox_id}\/subscriptions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/seedboxes\/:seedbox_id\/subscriptions", "query": [], "raw": "{{baseUrl}}\/api\/v1\/seedboxes\/:seedbox_id\/subscriptions", "variable": [ { "id": "seedbox_id", "key": "seedbox_id", "value": "architecto", "description": "The ID of the seedbox." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"state\":\"subscribed\",\"search\":\"b\",\"sort\":\"last_seen_at\",\"per_page\":22,\"page\":67}" }, "description": "" }, "response": [] }, { "name": "Request an unsubscribe from every actionable list matching the given filters.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/seedboxes\/:seedbox\/subscriptions\/unsubscribe-all", "query": [], "raw": "{{baseUrl}}\/api\/v1\/seedboxes\/:seedbox\/subscriptions\/unsubscribe-all", "variable": [ { "id": "seedbox", "key": "seedbox", "value": "58C6f7nnFCJ9M6rjyc6rTKMzn6", "description": "The seedbox." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"state\":\"mail_after_unsubscribe\",\"search\":\"b\",\"sort\":\"severity\"}" }, "description": "Requests are paced, so this answers 202 with counts rather than a per-list\noutcome." }, "response": [] }, { "name": "POST api\/v1\/seedboxes\/{seedbox}\/subscriptions\/{subscription}\/unsubscribe", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/seedboxes\/:seedbox\/subscriptions\/:subscription\/unsubscribe", "query": [], "raw": "{{baseUrl}}\/api\/v1\/seedboxes\/:seedbox\/subscriptions\/:subscription\/unsubscribe", "variable": [ { "id": "seedbox", "key": "seedbox", "value": "58C6f7nnFCJ9M6rjyc6rTKMzn6", "description": "The seedbox." }, { "id": "subscription", "key": "subscription", "value": "564", "description": "The subscription." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "GET api\/v1\/seedboxes\/{seedbox}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/seedboxes\/:seedbox", "query": [], "raw": "{{baseUrl}}\/api\/v1\/seedboxes\/:seedbox", "variable": [ { "id": "seedbox", "key": "seedbox", "value": "58C6f7nnFCJ9M6rjyc6rTKMzn6", "description": "The seedbox." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Update editable seedbox metadata without changing its address or lifecycle.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/seedboxes\/:seedbox", "query": [], "raw": "{{baseUrl}}\/api\/v1\/seedboxes\/:seedbox", "variable": [ { "id": "seedbox", "key": "seedbox", "value": "58C6f7nnFCJ9M6rjyc6rTKMzn6", "description": "The seedbox." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Transactional seedbox\",\"client_reference\":\"campaign-2026-07\",\"scan_blocklists\":true}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"01kzbqcfemk8k9bj46s9gx4jvc\",\"team_id\":44,\"name\":null,\"client_reference\":null,\"status\":\"active\",\"address\":\"opti@b-01kzbqcfemk8k9bj46s9gx4jvd.seeds.dev.optipub.com\",\"scan_blocklists\":false,\"receive_credits_per_message\":1,\"messages_count\":0,\"rejected_insufficient_credit_count\":0,\"unresolved_insufficient_credit_rejection_count\":0,\"accepting_messages\":true,\"can_delete\":false,\"revoked_at\":null,\"last_received_at\":null,\"last_rejected_insufficient_credit_at\":null,\"created_at\":\"2026-08-06T14:24:38+00:00\"},\"success\":true,\"message\":\"Seedbox updated successfully.\"}", "name": "" } ] }, { "name": "DELETE api\/v1\/seedboxes\/{seedbox}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/seedboxes\/:seedbox", "query": [], "raw": "{{baseUrl}}\/api\/v1\/seedboxes\/:seedbox", "variable": [ { "id": "seedbox", "key": "seedbox", "value": 58, "description": "The seedbox." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "DELETE api\/v1\/seedboxes\/{seedbox}\/delete", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/seedboxes\/:seedbox\/delete", "query": [], "raw": "{{baseUrl}}\/api\/v1\/seedboxes\/:seedbox\/delete", "variable": [ { "id": "seedbox", "key": "seedbox", "value": 58, "description": "The seedbox." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Spam Identifiers", "description": "", "item": [ { "name": "Retrieve Spam Identifiers.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/spam-identifiers", "query": [ { "key": "domain_id", "value": "01ARZ3NDEKTSV4RRFFQ69G5FAV", "description": "Optionally filter identifiers to a single accessible domain ULID.", "disabled": false }, { "key": "page", "value": "1", "description": "The page number for paginated identifier results.", "disabled": false }, { "key": "start_date", "value": "2026-01-22", "description": "Filter identifiers from this date (Y-m-d). Maximum selected range is 90 days.", "disabled": false }, { "key": "end_date", "value": "2026-04-22", "description": "Filter identifiers until this date (Y-m-d). Maximum selected range is 90 days.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/spam-identifiers?domain_id=01ARZ3NDEKTSV4RRFFQ69G5FAV&page=1&start_date=2026-01-22&end_date=2026-04-22" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all Gmail Postmaster Tools v2 spam (feedback loop) identifiers reported\nfor accessible domains in the given date range, along with each identifier's\naverage complaint rate across that window." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"message\":\"Spam identifiers retrieved successfully.\",\"data\":[{\"domain\":{\"id\":\"01ARZ3NDEKTSV4RRFFQ69G5FAV\",\"value\":\"example.com\"},\"identifier\":\"66189376\",\"sample_count\":57,\"average_complaint_rate\":0.12,\"min_complaint_rate\":0.05,\"max_complaint_rate\":0.31},{\"domain\":{\"id\":\"01ARZ3NDEKTSV4RRFFQ69G5FBG\",\"value\":\"example.net\"},\"identifier\":\"66189799\",\"sample_count\":40,\"average_complaint_rate\":0.05,\"min_complaint_rate\":0.01,\"max_complaint_rate\":0.14}],\"meta\":{\"current_page\":1,\"last_page\":1,\"per_page\":25,\"total\":2}}", "name": "" } ] }, { "name": "Retrieve Spam Identifier.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/spam-identifiers\/:identifier", "query": [ { "key": "domain_id", "value": "01ARZ3NDEKTSV4RRFFQ69G5FAV", "description": "Optionally filter the identifier to a single accessible domain ULID.", "disabled": false }, { "key": "start_date", "value": "2026-01-22", "description": "Start date of the reporting window (Y-m-d). Maximum selected range is 90 days.", "disabled": false }, { "key": "end_date", "value": "2026-04-22", "description": "End date of the reporting window (Y-m-d). Maximum selected range is 90 days.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/spam-identifiers\/:identifier?domain_id=01ARZ3NDEKTSV4RRFFQ69G5FAV&start_date=2026-01-22&end_date=2026-04-22", "variable": [ { "id": "identifier", "key": "identifier", "value": "66189376", "description": "The Gmail Postmaster Tools v2 spam (feedback loop) identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return the daily Gmail complaint rate time series for a single spam\n(feedback loop) identifier across accessible domains, plus the aggregate\naverage over the selected date range for each domain." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"message\":\"Spam identifier retrieved successfully.\",\"data\":[{\"identifier\":\"66189376\",\"domain\":{\"id\":\"01ARZ3NDEKTSV4RRFFQ69G5FAV\",\"value\":\"example.com\"},\"date_range\":{\"start_date\":\"2026-01-22\",\"end_date\":\"2026-04-22\"},\"aggregate\":{\"average_complaint_rate\":0.12,\"sample_count\":57},\"time_series\":[{\"date\":\"2026-01-22\",\"complaint_rate\":0.1},{\"date\":\"2026-01-23\",\"complaint_rate\":null}]}]}", "name": "" }, { "header": [], "code": 404, "body": "{\"success\":false,\"message\":\"Spam identifier not found for accessible domains in the selected date range.\",\"data\":[]}", "name": "" } ] } ] }, { "name": "Tools", "description": "", "item": [ { "name": "Screenshot", "description": "", "item": [ { "name": "Take Screenshot.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/screenshot\/take", "query": [], "raw": "{{baseUrl}}\/api\/v1\/screenshot\/take" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"url\":\"\\\"https:\\\/\\\/example.com\\\"\",\"width\":1280,\"height\":720,\"format\":\"\\\"png\\\"\",\"device_scale\":1}" }, "description": "Take a screenshot of a URL or HTML content." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"01kzbqcfcvv6024pw79n8d297q\",\"url\":\"https:\\\/\\\/assets.optipub.com\\\/postmaster\\\/screenshots\\\/01kzbqcfcnw7xyx8d4st3qqdet\\\/01kzbqcfcvv6024pw79n8d297q.png\",\"format\":\"png\",\"width\":1024,\"height\":600,\"device_scale\":3,\"credits_used\":1,\"started_at\":\"2026-07-27T08:26:12+00:00\",\"completed_at\":\"2026-07-27T08:26:25+00:00\",\"created_at\":\"2026-08-06T14:24:38+00:00\"},\"success\":true,\"message\":\"Screenshot taken successfully.\"}", "name": "" } ] }, { "name": "List Screenshots.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/screenshots", "query": [ { "key": "per_page", "value": "15", "description": "The number of screenshots per page (1-100). Defaults to 15. Must be at least 1. Must not be greater than 100.", "disabled": false }, { "key": "page", "value": "1", "description": "The page number. Must be at least 1.", "disabled": false }, { "key": "sort", "value": "-created_at", "description": "Sort order. Use `-` prefix for descending. Options: `created_at`, `-created_at`, `format`, `-format`. Defaults to `-created_at`.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/screenshots?per_page=15&page=1&sort=-created_at" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve a paginated list of screenshots for the current team." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Screenshots retrieved successfully.\",\n \"data\": [\n {\n \"id\": \"01ARZ3NDEKTSV4RRFFQ69G5FAV\",\n \"url\": \"https:\/\/assets.optipub.com\/postmaster\/screenshots\/01arz3ndektsv4rrffq69g5fav\/01arz3ndektsv4rrffq69g5fav.png\",\n \"format\": \"png\",\n \"width\": 1280,\n \"height\": 720,\n \"credits_used\": 1,\n \"created_at\": \"2024-01-15T10:30:00Z\"\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 5,\n \"per_page\": 15,\n \"to\": 15,\n \"total\": 75\n }\n}", "name": "" } ] }, { "name": "Get Screenshot.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/screenshot\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/screenshot\/:id", "variable": [ { "id": "id", "key": "id", "value": "01ARZ3NDEKTSV4RRFFQ69G5FAV", "description": "The ULID of the screenshot." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve details of a specific screenshot by its ID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"01kzbqcfdg45vbz3srh76hngnv\",\"url\":\"https:\\\/\\\/assets.optipub.com\\\/postmaster\\\/screenshots\\\/01kzbqcfdb2gan5pw88jsajkfx\\\/01kzbqcfdg45vbz3srh76hngnv.png\",\"format\":\"png\",\"width\":800,\"height\":600,\"device_scale\":2,\"credits_used\":1,\"started_at\":\"2026-07-27T05:07:02+00:00\",\"completed_at\":\"2026-07-27T05:07:32+00:00\",\"created_at\":\"2026-08-06T14:24:38+00:00\"},\"success\":true,\"message\":\"Screenshot retrieved successfully.\"}", "name": "" } ] } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "key", "type": "string" } ] } }