List Contacts
monica.list_contacts
ActionCRM & salesconnection required
Calls the Monica API with the connection's credentials.
Read a page of contacts, or search them by name.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Bearer token
- Providers
- Monica
- Secret shape
- the API token, or {"api_token": "…"}
- Config it needs
- 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 |
|---|---|---|---|---|---|
query Search the contacts by name; leave blank to list them all. | string | No | — | — | Lovelace |
page Which page of results to read, counting from one. | number | No | 1 | ≥ 1 | — |
limit How many contacts to return per page; Monica caps this at 100. | number | No | — | 1–100 | — |
sort The order the contacts come back in; a leading minus is descending. | string | No | — | one of "created_at", "-created_at", "updated_at", "-updated_at" | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"page": 1,
"query": "Lovelace"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
contacts The contacts on this page. | array | — |
count How many contacts this page carried. | number | — |
total How many contacts matched in total. | number | — |
page The page number Monica returned. | number | — |
last_page The number of the final page. | number | — |
has_more True when another page follows this one. | boolean | — |
query The search term that was applied, if any. | string | — |
{
"contacts": [],
"count": 0,
"has_more": false,
"last_page": 0,
"page": 0,
"query": "",
"total": 0
}See List Contacts run in a workflow.
In a technical demo we add the Monica connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.