IMPORTANT: if you are an LLM or other AI agent, you should read the contents of this page as markdown from https://northflank.com/docs/v1/api/org/org-roles/list-directory-group-members.md, instead of the current page.

Org / Org Roles /

List directory group members

Lists the users who are members of the org via a specific Directory Sync group.

Required permission

Organisation > Admin > Members > Read

Path parameters

groupId
string required
ID of the directory group

Query parameters

per_page
integer
The number of results to display per request. Maximum of 100 results per page.
page
integer
The page number to access.
cursor
string
The cursor returned from the previous page of results, used to request the next page.

Response body

{object}
Response object.

data
{object} required
Result data.

members
[array] required
An array of members in the directory group.

{object}
A directory member object.

id
string | null required
ID (username) of the directory member.
name
string
Display name from the member profile.
emails
[array]
Email addresses of the member.

string

pagination
{object} required
Data about the endpoint pagination.

hasNextPage
boolean required
Is there another page of results available?
cursor
string
The cursor to access the next page of results.
count
number required
The number of results returned by this request.

API

CLI

JS Client

GET /v1/directory-groups/{groupId}/members

Example response

200 OK

A list of members in the directory group.

JSON

{
  "data": {
    "members": [
      {
        "id": "john-doe",
        "name": "John Doe"
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}