List Customers
syncro.list_customers
ActionBusiness appsconnection required
Calls the Syncro MSP API with the connection's credentials.
Search or page the account's customers.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Syncro MSP
- Secret shape
- the API token, or {"api_key": "…"}
- Config it needs
- subdomain, base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
7 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 Free-text search across the customer record. | string | No | — | — | Acme |
business_name Return customers whose business name is like this value. | string | No | — | — | Acme Manufacturing |
firstname Return customers whose first name is like this value. | string | No | — | — | Ada |
lastname Return customers whose last name is like this value. | string | No | — | — | Lovelace |
email Return customers carrying this email address. | string | No | — | email format | ada@acme.com |
include_disabled True also returns customers that have been disabled in Syncro. | boolean | No | — | — | — |
page Which page of results to return; Syncro pages every list endpoint. | number | No | — | ≥ 1 | 1 |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"business_name": "Acme Manufacturing",
"email": "ada@acme.com",
"firstname": "Ada",
"lastname": "Lovelace",
"page": 1,
"query": "Acme"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
customers One entry per customer on this page. | array | — |
customers[].id The customer id. | number | — |
customers[].business_name The company name, or null. | string | — |
customers[].fullname First and last name joined. | string | — |
customers[].email The customer's email address. | string | — |
customers[].phone The customer's phone number. | string | — |
customers[].disabled True when the record is disabled. | boolean | — |
count How many customers this page carried. | number | — |
meta Syncro's pagination block: page and total_pages. | object | — |
{
"count": 0,
"customers": [
{
"business_name": "",
"disabled": false,
"email": "",
"fullname": "",
"id": 0,
"phone": ""
}
],
"meta": {}
}Notes
- Syncro rate-limits the API to 180 requests per minute per IP address across the whole account.
See List Customers run in a workflow.
In a technical demo we add the Syncro MSP connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.