List Companies
keap.list_companies
ActionCRM & salesconnection required
Calls the Keap API with the connection's credentials.
List companies from Keap, optionally filtered by company name.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- Keap
- Secret shape
- {"client_id": "…", "client_secret": "…", "refresh_token": "…"}
- Config it needs
- base_url, default_user_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
6 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 How many records to ask Keap for in this page. | number | No | — | ≥ 1 | 50 |
offset How many records to skip — page two of a 50-record page is offset 50. | number | No | — | ≥ 0 | — |
company_name Return only the companies with this name. | string | No | — | — | — |
order The Keap field the page is ordered by. | string | No | — | one of "id", "date_created", "name", "email" | — |
order_direction Whether the chosen order runs ascending or descending. | string | No | — | one of "ASCENDING", "DESCENDING" | — |
optional_properties Comma-separated Keap properties to add to the response; custom_fields, lead_source_id and job_title are omitted unless asked for. | string | No | — | — | custom_fields,job_title |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"limit": 50,
"optional_properties": "custom_fields,job_title"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
records The records in this page, exactly as Keap returned them. | array | — |
returned How many records this page actually contains. | number | — |
count The count Keap reported for the query. | number | — |
next Keap's URL for the following page, or an empty string. | string | — |
previous Keap's URL for the preceding page, or an empty string. | string | — |
{
"count": 0,
"next": "",
"previous": "",
"records": [],
"returned": 0
}Notes
- Keap pages with limit/offset and echoes a `next` URL when more records exist.
See List Companies run in a workflow.
In a technical demo we add the Keap connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.