Search Contacts
sendgrid.search_contacts
ActionEmailconnection required
Calls the SendGrid API with the connection's credentials.
Search marketing contacts with an SGQL query and return the matching contacts, at most the first fifty.
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
1 field, 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 |
|---|---|---|---|---|---|
query SGQL search string, for example email LIKE 'ada@%'. | string | Yes | — | — | email = 'ada@example.com' |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"query": "email = 'ada@example.com'"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items The matching contact objects. | array | — |
count How many contacts this response carries. | number | — |
contact_count How many contacts matched the query in total. | number | — |
{
"contact_count": 0,
"count": 0,
"items": []
}Notes
- Contact emails are stored lower-cased, so an email search term must be lower-cased too or it will not match.
Templates that use SendGrid
See Search Contacts 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.