FlowmageDocs

List groups

BetaReads data

Lists the groups in your Microsoft 365 directory.

Settings

SettingWhat it is
ConnectionRequiredThe Microsoft Graph connection the step signs in with.
FieldsComma-separated property names.
FilterAn OData filter. Microsoft 365 groups only: groupTypes/any(c:c eq 'Unified').
SearchMatches words in the display name or description only.
Sort bytext
Groups per call1 to 999.
Fetch every pageFollows Graph's own next-page link. A group made or deleted a moment ago may not show yet.
Stop afterPages — at most 50.
CursorPaste a previous run's Next cursor to read the page after it.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `microsoft-graph`)
selecttext, by default "id,displayName,description,mail,groupTypes,securityEnabled"
filtertext
searchtext
orderbytext
topnumber, by default 100
returnAlltrue/false, by default false
maxPagesnumber, by default 10
cursortext

Output

FieldType
groupsarray
countGroups in this answernumber
hasMoreMore groups are waiting behind this pageboolean
nextCursorCursor for the next pagestring
Sample output, and the expression for each field
  • count0
  • groups[]
  • hasMorefalse
  • nextCursor""

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": "",
    "filter": "",
    "maxPages": 10,
    "orderby": "",
    "returnAll": false,
    "search": "",
    "select": "id,displayName,description,mail,groupTypes,securityEnabled",
    "top": 100
  },
  "label": "List groups",
  "type": "graph.listGroups",
  "version": 1
}