FlowmageDocs

List contacts

BetaReads dataVersion 2

Lists the contacts in a Moneybird administration, filtered or searched.

Settings

SettingWhat it is
ConnectionRequiredThe Moneybird connection the step signs in with.
Administration idLeave 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.
SearchFree text over names, e-mail and customer number. Takes a value from an earlier node.
FiltersTyped literally, not from an earlier node — put a value from a previous step in Search above.
Pagenumber
Contacts per page1 to 100. Moneybird's own default differs per resource, so this is always sent.
Fetch every pageReads page after page, and refuses past 20,000 contacts rather than answering a short list.
CursorPaste a previous run's Next cursor to read the page after it.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `moneybird`)
administrationIdtexta value from the vendor's own list
querytext
filterslist of {key: text, value: text}, by default []
pagenumber, by default 1
perPagenumber, by default 50
returnAlltrue/false, by default false
cursortext

Output

FieldType
contactsarray
contactCountContacts on this pagenumber
hasMoreA next page may hold more contactsboolean
nextPageThe page number to read nextnumber
nextCursorCursor for the next pagestring
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
SettingWhat it is
ConnectionRequiredThe Moneybird connection the step signs in with.
Administration idLeave 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.
SearchFree text over names, e-mail and customer number. Takes a value from an earlier node.
FiltersTyped literally, not from an earlier node — put a value from a previous step in Search above.
Pagenumber
Contacts per page1 to 100. Moneybird's own default differs per resource, so this is always sent.
Fetch every pageReads page after page, and refuses past 20,000 contacts rather than answering a short list.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `moneybird`)
administrationIdtexta value from the vendor's own list
querytext
filterslist of {key: text, value: text}, by default []
pagenumber, by default 1
perPagenumber, by default 50
returnAlltrue/false, by default false