Get List
sendgrid.get_list
ActionEmailconnection required
Calls the SendGrid API with the connection's credentials.
Fetch one marketing contact list by id, optionally with a sample contact.
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
2 fields, 1 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 |
|---|---|---|---|---|---|
list_id Identifier of the list to fetch. | string | Yes | — | — | — |
contact_sample Include a sample contact from the list in the response. | boolean | No | false | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"contact_sample": false
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id Identifier of the list. | string | — |
name Name of the list. | string | — |
contact_count How many contacts the list holds. | number | — |
contact_sample Up to fifty recent contacts, present only when contact_sample is set. | array | — |
{
"contact_count": 0,
"contact_sample": [],
"id": "",
"name": ""
}Templates that use SendGrid
See Get List 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.