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

Team / Team Roles /

List team role members

Gets a list of members assigned to a platform role in a team.

Required permission

Account > Admin > Roles > Read

Path parameters

teamId
string required
ID of the team
roleId
string required
ID of the team role

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.
userIds

Filter members by user ID. Specify the parameter multiple times to filter by multiple user IDs.

Response body

{object}
Response object.

data
{object} required
Result data.

members
[array] required
An array of members in the team role.

{object}
A team role member object.

id
string | null required
ID (username) of the team member. For users who are not finalized this ID may change on finalisation.
name
string
Display name from the member profile.
emails
[array]
Email addresses of the member.

{object}

address
string required
verified
boolean required

joinedAt
string
The time the member joined the team.
finalized
boolean
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/teams/{teamId}/roles/{roleId}/members

Example response

200 OK

A list of members in the team role.

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
  }
}