List Customers
paddle.list_customers
ActionBusiness appsconnection required
Calls the Paddle API with the connection's credentials.
List or search customers by name, email or Paddle id.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Paddle
- Secret shape
- the Paddle API key (pdl_…), or {"api_key": "…"}
- Config it needs
- environment, 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 |
|---|---|---|---|---|---|
search Free-text search across customer id, name and email. | string | No | — | ≤ 100 characters | — |
email Comma-separated email addresses to match exactly. | string | No | — | — | — |
status Only customers in this state; Paddle returns active by default. | string | No | — | one of "active", "archived" | — |
per_page How many records to return in one page (Paddle's maximum is 200). | number | No | — | 1–200 | 50 |
after Paddle id to continue after — pass the previous run's next_after. | string | No | — | — | — |
order_by Sort clause such as id[ASC] or created_at[DESC]. | string | No | — | — | — |
ids Comma-separated Paddle ids to return only those records. | string | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"per_page": 50
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items The records on this page, exactly as Paddle returned them. | array | — |
count How many records are on this page. | number | — |
next_after Cursor to pass as 'after' for the next page; empty at the end. | string | — |
next_url Paddle's own URI for the next page, or empty at the end. | string | — |
has_more True when Paddle has further pages to give. | boolean | — |
estimated_total Paddle's estimate of the total matching records. | number | — |
request_id Paddle's request id, quoted when contacting their support. | string | — |
{
"count": 0,
"estimated_total": 0,
"has_more": false,
"items": [],
"next_after": "",
"next_url": "",
"request_id": ""
}See List Customers run in a workflow.
In a technical demo we add the Paddle connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.