FlowmageDocs

List contacts

BetaReads dataVersion 2

Fetches the people in the MessageBird contact list.

Settings

SettingWhat it is
ConnectionRequiredThe MessageBird connection the step signs in with.
Contacts per call1 to 100. MessageBird answers 20 by default.
SkipHow many contacts to skip. Ignored when Fetch every page is on.
Fetch every pageWalks the offset from the start, and refuses past 5,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 `messagebird`)
limitnumber, by default 20
offsetnumber, by default 0
returnAlltrue/false, by default false
cursortext

Output

FieldType
contactsarray
contactCountContacts in this answernumber
hasMoreMore contacts are waiting behind this pageboolean
totalCountContacts MessageBird has in totalnumber
nextCursorCursor for the next pagestring
Sample output, and the expression for each field
  • contactCount0
  • contacts[]
  • hasMorefalse
  • totalCount0

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": {
    "connection": "<connection id>",
    "cursor": "",
    "limit": 20,
    "offset": 0,
    "returnAll": false
  },
  "label": "List contacts",
  "type": "messagebird.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 MessageBird connection the step signs in with.
Contacts per call1 to 100. MessageBird answers 20 by default.
SkipHow many contacts to skip. Ignored when Fetch every page is on.
Fetch every pageWalks the offset from the start, and refuses past 5,000 contacts rather than answering a short list.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `messagebird`)
limitnumber, by default 20
offsetnumber, by default 0
returnAlltrue/false, by default false