FlowmageDocs

List users

BetaReads dataVersion 2

Lists the recruiters and consultants inside your Carerix environment.

Settings

SettingWhat it is
ConnectionRequiredThe Carerix connection the step signs in with.
QualifierA Carerix qualifier, the same expression the Carerix client's own searches use — for example toStatusNode.code='active' or modificationDate>'2026-09-01 00:00:00'. Leave it empty for every record. Dates are yyyy-MM-dd HH:mm:ss in Amsterdam time.
Fetch every pageClimbs Carerix's page numbers until the last one, and refuses past 5,000 users rather than answering a short list.
PageCarerix counts pages from 0.
Users per page1 to 100 — Carerix answers at most 100 records per request.
Include deleted recordsCarerix keeps deleted records; off, they stay out of the answer.
List-value languageWhich language Carerix answers its list values (statuses, types, results) in. It does not translate the data.
Fields to fetchThe selection set Carerix answers, written as GraphQL fields separated by spaces. Add a field here to get it back; docs.carerix.io/graphql lists them all.
CursorPaste a previous run's Next cursor to read the page after it.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `carerix`)
qualifiertext
returnAlltrue/false, by default false
pagenumber, by default 0
sizenumber, by default 100
includeDeletedtrue/false, by default false
language"" or "DUTCH" or "ENGLISH" or "FRENCH" or "GERMAN" or "HUNGARIAN" or "ITALIAN" or "POLISH" or "PORTUGUESE" or "SPANISH"
fieldstext, by default "_id _kind firstName lastName lastNamePrefix emailAddress phoneNumberBusiness mobileNumber jobTitle isActive creationDate modificationDate toCompany { _id name }"
cursortext

Output

FieldType
usersarray
userCountUsers in this answernumber
hasMoreMore pages are waiting behind this oneboolean
totalElementsRecords Carerix says matchnumber
pageThe page this answer came fromnumber
nextPageThe next page number — absent on the last pagenumber
nextCursorCursor for the next pagestring
Sample output, and the expression for each field
  • hasMorefalse
  • page0
  • totalElements0
  • userCount0
  • users[]

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": "",
    "fields": "_id _kind firstName lastName lastNamePrefix emailAddress phoneNumberBusiness mobileNumber jobTitle isActive creationDate modificationDate toCompany { _id name }",
    "includeDeleted": false,
    "language": "",
    "page": 0,
    "qualifier": "",
    "returnAll": false,
    "size": 100
  },
  "label": "List users",
  "type": "carerix.listUsers",
  "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 Carerix connection the step signs in with.
QualifierA Carerix qualifier, the same expression the Carerix client's own searches use — for example toStatusNode.code='active' or modificationDate>'2026-09-01 00:00:00'. Leave it empty for every record. Dates are yyyy-MM-dd HH:mm:ss in Amsterdam time.
Fetch every pageClimbs Carerix's page numbers until the last one, and refuses past 5,000 users rather than answering a short list.
PageCarerix counts pages from 0.
Users per page1 to 100 — Carerix answers at most 100 records per request.
Include deleted recordsCarerix keeps deleted records; off, they stay out of the answer.
List-value languageWhich language Carerix answers its list values (statuses, types, results) in. It does not translate the data.
Fields to fetchThe selection set Carerix answers, written as GraphQL fields separated by spaces. Add a field here to get it back; docs.carerix.io/graphql lists them all.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `carerix`)
qualifiertext
returnAlltrue/false, by default false
pagenumber, by default 0
sizenumber, by default 100
includeDeletedtrue/false, by default false
language"" or "DUTCH" or "ENGLISH" or "FRENCH" or "GERMAN" or "HUNGARIAN" or "ITALIAN" or "POLISH" or "PORTUGUESE" or "SPANISH"
fieldstext, by default "_id _kind firstName lastName lastNamePrefix emailAddress phoneNumberBusiness mobileNumber jobTitle isActive creationDate modificationDate toCompany { _id name }"