List Members
curl --request GET \
--url https://api.example.com/api/auth/organizations/members \
--header 'X-Organization-Id: <x-organization-id>'import requests
url = "https://api.example.com/api/auth/organizations/members"
headers = {"X-Organization-Id": "<x-organization-id>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Organization-Id': '<x-organization-id>'}};
fetch('https://api.example.com/api/auth/organizations/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://api.example.com/api/auth/organizations/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 => [
"X-Organization-Id: <x-organization-id>"
],
]);
$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://api.example.com/api/auth/organizations/members"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Organization-Id", "<x-organization-id>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/auth/organizations/members")
.header("X-Organization-Id", "<x-organization-id>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/auth/organizations/members")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Organization-Id"] = '<x-organization-id>'
response = http.request(request)
puts response.read_body{
"members": [
{
"membership_id": "mem_abc123",
"user_id": "user_def456",
"email": "user@example.com",
"name": "John Doe",
"role": "admin",
"status": "active",
"joined_at": "2024-01-01T12:00:00Z",
"last_login": "2024-03-01T08:30:00Z"
}
]
}
Organizations
List Members
GET
/
api
/
auth
/
organizations
/
members
List Members
curl --request GET \
--url https://api.example.com/api/auth/organizations/members \
--header 'X-Organization-Id: <x-organization-id>'import requests
url = "https://api.example.com/api/auth/organizations/members"
headers = {"X-Organization-Id": "<x-organization-id>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Organization-Id': '<x-organization-id>'}};
fetch('https://api.example.com/api/auth/organizations/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://api.example.com/api/auth/organizations/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 => [
"X-Organization-Id: <x-organization-id>"
],
]);
$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://api.example.com/api/auth/organizations/members"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Organization-Id", "<x-organization-id>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/auth/organizations/members")
.header("X-Organization-Id", "<x-organization-id>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/auth/organizations/members")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Organization-Id"] = '<x-organization-id>'
response = http.request(request)
puts response.read_body{
"members": [
{
"membership_id": "mem_abc123",
"user_id": "user_def456",
"email": "user@example.com",
"name": "John Doe",
"role": "admin",
"status": "active",
"joined_at": "2024-01-01T12:00:00Z",
"last_login": "2024-03-01T08:30:00Z"
}
]
}
Retrieve a list of all members within your organization.
Request
string
required
The unique identifier of the organization.
Response
array
List of member objects belonging to the organization.
Show Member Object
Show Member Object
string
The unique identifier for the membership.
string
The unique identifier of the user.
string
The email address of the user.
string
The full name of the user.
string
The role of the member (e.g.,
admin, agent_manager, user).string
The current status of the membership (e.g.,
active).string
The timestamp when the user joined the organization.
string
The timestamp of the user’s last login.
{
"members": [
{
"membership_id": "mem_abc123",
"user_id": "user_def456",
"email": "user@example.com",
"name": "John Doe",
"role": "admin",
"status": "active",
"joined_at": "2024-01-01T12:00:00Z",
"last_login": "2024-03-01T08:30:00Z"
}
]
}
⌘I