Get List
affinity.get_list
ActionCRM & salesconnection required
Calls the Affinity API with the connection's credentials.
Return one Affinity list, including the field definitions on it.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Affinity
- Secret shape
- the API key, or {"api_key": "…"}
- Config it needs
- base_url
- 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 |
|---|---|---|---|---|---|
list_id The numeric id of the Affinity list to act on. | string | Yes | — | — | 123 |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"list_id": "123"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id The list's numeric id. | number | — |
type 0 for a people list, 1 for organizations, 8 for opportunities. | number | — |
name The list's name. | string | — |
public True when everyone in the workspace can see the list. | boolean | — |
owner_id The internal person id of the list's owner. | number | — |
list_size How many entries the list holds. | number | — |
fields The list's field definitions, when the single-list call was used. | array | — |
{
"fields": [],
"id": 0,
"list_size": 0,
"name": "",
"owner_id": 0,
"public": false,
"type": 0
}See Get List run in a workflow.
In a technical demo we add the Affinity connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.