curl -X GET "https://api.caret.so/v1/workspace/members?limit=10&offset=0" \
-H "Authorization: Bearer your_api_key_here"
const response = await fetch(
'https://api.caret.so/v1/workspace/members?limit=10&offset=0',
{
headers: {
Authorization: 'Bearer your_api_key_here',
},
},
);
const data = await response.json();
console.log(data);
import requests
url = "https://api.caret.so/v1/workspace/members"
params = {
"limit": "10",
"offset": "0"
}
headers = {
"Authorization": "Bearer your_api_key_here"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())
{
"items": [
{
"id": "user_123456789",
"name": "John Doe",
"email": "john@example.com",
"profileUrl": "https://example.com/profile.jpg",
"role": "admin",
"createdAt": "2023-01-01T00:00:00Z",
"folders": [
{
"id": "folder_123",
"name": "Product"
}
]
}
],
"pagination": {
"limit": 10,
"offset": 0,
"total": 1
}
}
{
"error": {
"code": "unauthorized",
"message": "Invalid or missing API key"
}
}
{
"error": {
"code": "forbidden",
"message": "Missing required scope: users"
}
}
メンバー
メンバー一覧取得
ワークスペースメンバーのページネーションされた一覧を取得します
GET
/
v1
/
workspace
/
members
curl -X GET "https://api.caret.so/v1/workspace/members?limit=10&offset=0" \
-H "Authorization: Bearer your_api_key_here"
const response = await fetch(
'https://api.caret.so/v1/workspace/members?limit=10&offset=0',
{
headers: {
Authorization: 'Bearer your_api_key_here',
},
},
);
const data = await response.json();
console.log(data);
import requests
url = "https://api.caret.so/v1/workspace/members"
params = {
"limit": "10",
"offset": "0"
}
headers = {
"Authorization": "Bearer your_api_key_here"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())
{
"items": [
{
"id": "user_123456789",
"name": "John Doe",
"email": "john@example.com",
"profileUrl": "https://example.com/profile.jpg",
"role": "admin",
"createdAt": "2023-01-01T00:00:00Z",
"folders": [
{
"id": "folder_123",
"name": "Product"
}
]
}
],
"pagination": {
"limit": 10,
"offset": 0,
"total": 1
}
}
{
"error": {
"code": "unauthorized",
"message": "Invalid or missing API key"
}
}
{
"error": {
"code": "forbidden",
"message": "Missing required scope: users"
}
}
概要
このエンドポイントは、ワークスペースメンバーのページネーションされた一覧を返します。searchパラメータを使用して、名前またはメールで結果をフィルタリングできます。
認証
すべてのAPIリクエストはAuthorization: Bearer <API_KEY> で認証します。このエンドポイントにはusersスコープが必要です。
string
必須
Bearerトークン。形式:
Bearer <API_KEY>。クエリパラメータ
string
デフォルト:"10"
ページあたりのアイテム数。
string
デフォルト:"0"
開始位置。
string
名前またはメールで検索。
レスポンス
object[]
curl -X GET "https://api.caret.so/v1/workspace/members?limit=10&offset=0" \
-H "Authorization: Bearer your_api_key_here"
const response = await fetch(
'https://api.caret.so/v1/workspace/members?limit=10&offset=0',
{
headers: {
Authorization: 'Bearer your_api_key_here',
},
},
);
const data = await response.json();
console.log(data);
import requests
url = "https://api.caret.so/v1/workspace/members"
params = {
"limit": "10",
"offset": "0"
}
headers = {
"Authorization": "Bearer your_api_key_here"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())
{
"items": [
{
"id": "user_123456789",
"name": "John Doe",
"email": "john@example.com",
"profileUrl": "https://example.com/profile.jpg",
"role": "admin",
"createdAt": "2023-01-01T00:00:00Z",
"folders": [
{
"id": "folder_123",
"name": "Product"
}
]
}
],
"pagination": {
"limit": 10,
"offset": 0,
"total": 1
}
}
{
"error": {
"code": "unauthorized",
"message": "Invalid or missing API key"
}
}
{
"error": {
"code": "forbidden",
"message": "Missing required scope: users"
}
}
⌘I