List Records
invoiceninja.list_records
ActionBusiness appsconnection required
Calls the Invoice Ninja API with the connection's credentials.
List a page of clients, invoices, payments, quotes, tasks or expenses, narrowed by a search term, a status, a client or a sort order.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Invoice Ninja
- Secret shape
- the API token, or {"api_token": "…", "api_secret": "…"}
- Config it needs
- base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
8 fields, 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 |
|---|---|---|---|---|---|
resource Which Invoice Ninja entity to act on. | string | Yes | — | one of "clients", "invoices", "payments", "quotes", "tasks", "expenses" | — |
search Free text matched across several columns of the entity at once; this is Invoice Ninja's broad 'filter' argument. | string | No | — | — | Acme |
status Only return records in this state. | string | No | — | one of "active", "archived", "deleted" | — |
client_id Only return records belonging to this client, by the client's id. | string | No | — | — | Opnel5aKBz |
include Comma-separated relationships to embed in the response, such as contacts. | string | No | — | — | contacts |
sort Sort order as column|direction, such as created_at|desc. | string | No | — | — | created_at|desc |
per_page How many records to return per page. | number | No | 20 | 1–5000 | — |
page Which page of results to return, counting from one. | number | No | — | ≥ 1 | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"client_id": "Opnel5aKBz",
"include": "contacts",
"per_page": 20,
"search": "Acme",
"sort": "created_at|desc"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
data The records on this page. | array | — |
count How many records this page carried. | number | — |
pagination Invoice Ninja's pagination block for this list. | object | — |
pagination.total How many records match in total. | number | — |
pagination.count How many records this page carried. | number | — |
pagination.per_page The page size Invoice Ninja applied. | number | — |
pagination.current_page The page number returned. | number | — |
pagination.total_pages How many pages there are in total. | number | — |
{
"count": 0,
"data": [],
"pagination": {
"count": 0,
"current_page": 0,
"per_page": 0,
"total": 0,
"total_pages": 0
}
}Related Invoice Ninja nodes
See List Records run in a workflow.
In a technical demo we add the Invoice Ninja connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.