List Contacts Of A List

emelia.list_contacts
ActionEmailconnection required

Calls the Emelia API with the connection's credentials.

List a page of a contact list, or look one contact up exactly.

Connection

Required
Yes — the node will not save without one
Auth type
API key
Providers
Emelia
Secret shape
the API key, or {"api_key": "…"}
Config it needs
list_id
Resolved by
config.connection_id, else node.connection_id

Configuration

8 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

FieldTypeRequiredDefaultConstraintsExample
list_id
Emelia list to act on; leave blank to use the list named on the connection.
stringNo——65f0a1b2c3d4e5f6a7b8c9d0
email
Return only the contact with this exact email address, matched case-insensitively.
stringNo—email formatjane@example.com
linkedin_url
Return only the contact with this exact LinkedIn profile URL.
stringNo—url formathttps://www.linkedin.com/in/janedoe/
page
Which page of contacts to return; Emelia starts at page 1.
numberNo—≥ 1—
page_size
How many contacts to return per page; Emelia returns 50 by default.
numberNo—1–100—
search
Free-text search across the contacts of the list.
stringNo———
sort_by
Name of the field the contacts are sorted by.
stringNo———
sort_dir
Direction the rows are sorted in when a sort column is named.
stringNo—one of "asc", "desc"—

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "email": "jane@example.com",
  "linkedin_url": "https://www.linkedin.com/in/janedoe/",
  "list_id": "65f0a1b2c3d4e5f6a7b8c9d0"
}

Output

One shape.

result

FieldTypeExample
items
The rows Emelia returned for this page.
array—
count
How many rows this page carried.
number—
total
How many rows match in total, across every page.
number—
page
The page number Emelia returned.
number—
page_size
How many rows per page Emelia used.
number—
custom_variables
The custom variables this list uses.
array—
list_id
The list the contacts were read from.
string—
{
  "count": 0,
  "custom_variables": [],
  "items": [],
  "list_id": "",
  "page": 0,
  "page_size": 0,
  "total": 0
}

Notes

  • The 'email' and 'linkedin_url' lookups are mutually exclusive and take precedence over the search and the paging.

See List Contacts Of A List run in a workflow.

In a technical demo we add the Emelia connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.