Get the members assigned to an organization role

List the organization members assigned a specific role within the context of an organization.

GET https://{tenantDomain}/api/v2/organizations/{id}/roles/{role_id}/members

Get the members assigned to an organization role

cURL

curl --request GET \
  --url https://{tenantDomain}/api/v2/organizations/{id}/roles/{role_id}/members \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenantDomain}/api/v2/organizations/{id}/roles/{role_id}/members"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{tenantDomain}/api/v2/organizations/{id}/roles/{role_id}/members', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/organizations/{id}/roles/{role_id}/members",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenantDomain}/api/v2/organizations/{id}/roles/{role_id}/members"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{tenantDomain}/api/v2/organizations/{id}/roles/{role_id}/members")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/organizations/{id}/roles/{role_id}/members")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "members": [
    {
      "user_id": "<string>",
      "picture": "<string>",
      "name": "<string>",
      "email": "[e-mail]"
    }
  ],
  "next": "<string>"
}

{
  "message": "<string>",
  "statusCode": "<unknown>",
  "error": "<unknown>"
}

{
  "message": "<string>",
  "statusCode": "<unknown>",
  "error": "<unknown>"
}

{
  "message": "<string>",
  "statusCode": "<unknown>",
  "error": "<unknown>"
}

{
  "message": "<string>",
  "statusCode": "<unknown>",
  "error": "<unknown>"
}

{
  "message": "<string>",
  "statusCode": "<unknown>",
  "error": "<unknown>"
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string<organization-id> · required

ID of the organization.

role_id · string<role-id> · required

ID of the role to retrieve the assigned members for.

Query Parameters

from · string

Optional Id from which to start selection.

take · integer · default: 50

Number of results per page. Defaults to 50. Values above the maximum permitted size are capped.

Required range: x >= 1

fields · string

Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields.

include_fields · boolean · default: true

Whether specified fields are to be included (true) or excluded (false). Defaults to true.

Response

200

application/json

Role members successfully retrieved.

members · object[] · required

List of members assigned to the role within the organization.

Show child attributes

next · string

Cursor for the next page of results. Absent when there are no more results.