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-members/list-org-members.md, instead of the current page.

Org / Org Members /

List org members

Gets a list of members belonging to the authenticated org.

Required permission

Organisation > Admin > Members > Read

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 org members.

{object}
An org member object.

id
string required
ID (username) of the org member. For users who are not finalized this ID may change on finalisation.
pattern
^[A-Za-z0-9-]+$
name
string
Display name from the member profile.
emails
[array]
Email addresses of the member.

{object}
Email addresses of the member.

address
string
verified
boolean

joinedAt
string
The time the member joined the org.
finalized
boolean required
Whether the account has been fully set up by the user.

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/org-members

Example response

200 OK

A list of members in the org.

JSON

{
  "data": {
    "members": [
      {
        "id": "john-doe",
        "name": "John Doe",
        "emails": [
          {
            "address": "john@example.com",
            "verified": true
          }
        ],
        "joinedAt": "2021-01-20T11:19:53.175Z"
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}