List Contacts
mailjet.list_contacts
ActionEmailconnection required
Calls the Mailjet API with the connection's credentials.
List the account's contacts, optionally only those on one list.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Username & password
- Providers
- Mailjet
- Secret shape
- {"username": "<public API key>", "password": "<private API key>"} (+ "sms_token" for the SMS API)
- Config it needs
- sender_email, sender_name, sms_from, contacts_list_id, base_url
- 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 |
|---|---|---|---|---|---|
limit Maximum records to return in this page. Mailjet caps the value at 1000. | number | No | 100 | 1–1000 | — |
offset How many records to skip before this page — Mailjet's cursor for paging. | number | No | 0 | ≥ 0 | — |
list_id Numeric id of the Mailjet contact list. Falls back to the list on the connection when left blank. | string | No | — | — | 10012345 |
is_excluded_from_campaigns Filter to contacts that are excluded from campaigns, or to those that are not. Leave unset to return both. | boolean | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"limit": 100,
"list_id": "10012345",
"offset": 0
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items The records Mailjet returned in this page. | array | — |
count How many records this page returned. | number | — |
total How many records match the query in total. | number | — |
{
"count": 0,
"items": [],
"total": 0
}See List Contacts run in a workflow.
In a technical demo we add the Mailjet connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.