List contacts
Lists the contacts in a Moneybird administration, filtered or searched.
Settings
| Setting | What it is |
|---|---|
| ConnectionRequired | The Moneybird connection the step signs in with. |
| Administration id | Leave empty to use the connection's administration. Pick another this token can reach, or type its id — the List administrations node gives you the ids. |
| Search | Free text over names, e-mail and customer number. Takes a value from an earlier node. |
| Filters | Typed literally, not from an earlier node — put a value from a previous step in Search above. |
| Page | number |
| Contacts per page | 1 to 100. Moneybird's own default differs per resource, so this is always sent. |
| Fetch every page | Reads page after page, and refuses past 20,000 contacts rather than answering a short list. |
| Cursor | Paste a previous run's Next cursor to read the page after it. |
Technical details
| Key | Value |
|---|---|
connection | texta connection id from `requires.connections` (provider `moneybird`) |
administrationId | texta value from the vendor's own list |
query | text |
filters | list of {key: text, value: text}, by default [] |
page | number, by default 1 |
perPage | number, by default 50 |
returnAll | true/false, by default false |
cursor | text |
Output
| Field | Type |
|---|---|
contacts | array |
contactCountContacts on this page | number |
hasMoreA next page may hold more contacts | boolean |
nextPageThe page number to read next | number |
nextCursorCursor for the next page | string |
Sample output, and the expression for each field
- contactCount0
- contacts[]
- hasMorefalse
- nextPage0
Errors
When a step of this node stops a run, the run page shows a code. Look it up:
Example step
The step as a flow file holds it. Replace each value in <…>.
{
"config": {
"administrationId": "",
"connection": "<connection id>",
"cursor": "",
"filters": [],
"page": 1,
"perPage": 50,
"query": "",
"returnAll": false
},
"label": "List contacts",
"type": "moneybird.listContacts",
"version": 2
}Older versions
A flow that already has this version keeps running it. A new step always gets the newest.
Version 1
| Setting | What it is |
|---|---|
| ConnectionRequired | The Moneybird connection the step signs in with. |
| Administration id | Leave empty to use the connection's administration. Pick another this token can reach, or type its id — the List administrations node gives you the ids. |
| Search | Free text over names, e-mail and customer number. Takes a value from an earlier node. |
| Filters | Typed literally, not from an earlier node — put a value from a previous step in Search above. |
| Page | number |
| Contacts per page | 1 to 100. Moneybird's own default differs per resource, so this is always sent. |
| Fetch every page | Reads page after page, and refuses past 20,000 contacts rather than answering a short list. |
Technical details
| Key | Value |
|---|---|
connection | texta connection id from `requires.connections` (provider `moneybird`) |
administrationId | texta value from the vendor's own list |
query | text |
filters | list of {key: text, value: text}, by default [] |
page | number, by default 1 |
perPage | number, by default 50 |
returnAll | true/false, by default false |