List Spam Reports
sendgrid.list_spam_reports
ActionEmailconnection required
Calls the SendGrid API with the connection's credentials.
List addresses that reported a message as spam, optionally within a Unix-timestamp window.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- SendGrid
- Secret shape
- {"api_key": "…"}, or the API key on its own
- Config it needs
- from_email, from_name
- Resolved by
- config.connection_id, else node.connection_id
Configuration
4 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
start_time Unix timestamp of the earliest spam report to return. | number | No | — | ≥ 0 | — |
end_time Unix timestamp of the latest spam report to return. | number | No | — | ≥ 0 | — |
limit How many spam reports to return; SendGrid allows 1 to 500. | number | No | — | 1–500 | — |
offset How many spam reports to skip before returning. | number | No | — | ≥ 0 | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items[].email The address that reported the message as spam. | string | — |
items[].created Unix timestamp the report was recorded. | number | — |
items[].ip The sending IP the reported message went out on. | string | — |
count How many spam reports this response carries. | number | — |
{
"count": 0,
"items": [
{
"created": 0,
"email": "",
"ip": ""
}
]
}Templates that use SendGrid
See List Spam Reports run in a workflow.
In a technical demo we add the SendGrid connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.