List members
Returns a paginated list of workspace members with their roles and status.
curl --request GET \
--url https://api.example.com/workspaces/{workspaceId}/membersimport requests
url = "https://api.example.com/workspaces/{workspaceId}/members"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/workspaces/{workspaceId}/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/workspaces/{workspaceId}/members",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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/workspaces/{workspaceId}/members"
req, _ := http.NewRequest("GET", url, nil)
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/workspaces/{workspaceId}/members")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/workspaces/{workspaceId}/members")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"items": [
{
"createdAt": "2023-11-07T05:31:56Z",
"emailAddress": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"memberRole": "owner",
"username": "<string>",
"avatarUrl": "<string>",
"displayName": "<string>"
}
],
"nextCursor": "<string>",
"total": 123
}{
"message": "<string>",
"name": "<string>"
}{
"message": "<string>",
"name": "<string>"
}{
"message": "<string>",
"name": "<string>"
}Path Parameters
Workspace identifier.
Query Parameters
Sort order (asc or desc).
"ascending"Filter by workspace role.
"owner"Sort by field.
"name"Cursor pointing to the last item of the previous page.
Obtain this from the nextCursor field in the response.
Whether to include the total item count in the response's total field.
Defaults to false, since counting is an extra query; set it to true
only when the count is actually needed.
The maximum number of records to return (1-100, default: 20).
1 <= x <= 100Response
Generic paginated response wrapper.
Provides a consistent structure for all paginated API responses with
cursor-based pagination support. When next_cursor is present, there
are more items to fetch.
Generic paginated response wrapper.
Provides a consistent structure for all paginated API responses with
cursor-based pagination support. When next_cursor is present, there
are more items to fetch.
curl --request GET \
--url https://api.example.com/workspaces/{workspaceId}/membersimport requests
url = "https://api.example.com/workspaces/{workspaceId}/members"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/workspaces/{workspaceId}/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/workspaces/{workspaceId}/members",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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/workspaces/{workspaceId}/members"
req, _ := http.NewRequest("GET", url, nil)
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/workspaces/{workspaceId}/members")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/workspaces/{workspaceId}/members")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"items": [
{
"createdAt": "2023-11-07T05:31:56Z",
"emailAddress": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"memberRole": "owner",
"username": "<string>",
"avatarUrl": "<string>",
"displayName": "<string>"
}
],
"nextCursor": "<string>",
"total": 123
}{
"message": "<string>",
"name": "<string>"
}{
"message": "<string>",
"name": "<string>"
}{
"message": "<string>",
"name": "<string>"
}