メインコンテンツへスキップ
GET
/
v1
/
invites
curl --request GET \
  --url https://api.caret.so/v1/invites?limit=20&offset=0 \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "id": "inv_123",
      "email": "user@example.com",
      "code": "abc123xy",
      "role": "member",
      "expiresAt": "2026-02-27T10:00:00Z",
      "createdAt": "2026-01-28T10:00:00Z",
      "isUrlInvite": false,
      "folders": [
        {
          "id": "fol_456",
          "name": "Marketing"
        }
      ]
    }
  ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "total": 1
  }
}

​
クエリパラメータ

​
limit
number
デフォルト:"20"
返すアイテムの数。
​
offset
number
デフォルト:"0"
結果の収集を開始する前にスキップするアイテムの数。

​
レスポンス

​
items
Invite[]
​
pagination
object
​
limit
number
返されたアイテムの数。
​
offset
number
スキップされたアイテムの数。
​
total
number
利用可能なアイテムの総数。
curl --request GET \
  --url https://api.caret.so/v1/invites?limit=20&offset=0 \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "id": "inv_123",
      "email": "user@example.com",
      "code": "abc123xy",
      "role": "member",
      "expiresAt": "2026-02-27T10:00:00Z",
      "createdAt": "2026-01-28T10:00:00Z",
      "isUrlInvite": false,
      "folders": [
        {
          "id": "fol_456",
          "name": "Marketing"
        }
      ]
    }
  ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "total": 1
  }
}