메인 콘텐츠로 건너뛰기
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
  }
}