メインコンテンツへスキップ
GET
/
v1
/
workspace
/
members

curl -X GET "https://api.caret.so/v1/workspace/members?limit=10&offset=0" \
     -H "X-API-Key: your_api_key_here"


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

​
概要

このエンドポイントは、ワークスペースメンバーのページネーションされた一覧を返します。searchパラメータを使用して、名前またはメールで結果をフィルタリングできます。

​
認証

すべてのAPIリクエストには、X-API-Key HTTPヘッダーにAPIキーを含める必要があります。このエンドポイントにはusersスコープが必要です。
​
X-API-Key
string
必須
Caret APIキー。

​
クエリパラメータ

​
limit
string
デフォルト:"10"
ページあたりのアイテム数。
​
offset
string
デフォルト:"0"
開始位置。
​
search
string
名前またはメールで検索。

​
レスポンス

​
items
object[]
ワークスペースメンバーのリスト。
​
pagination
object
ページネーションメタデータ。

curl -X GET "https://api.caret.so/v1/workspace/members?limit=10&offset=0" \
     -H "X-API-Key: your_api_key_here"


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