> ## Documentation Index
> Fetch the complete documentation index at: https://docs.caret.so/llms.txt
> Use this file to discover all available pages before exploring further.

# 招待一覧取得

> ワークスペースの保留中のすべての招待のページネーションされた一覧を取得します

### クエリパラメータ

<ParamField query="limit" type="number" default="20">
  返すアイテムの数。
</ParamField>

<ParamField query="offset" type="number" default="0">
  結果の収集を開始する前にスキップするアイテムの数。
</ParamField>

### レスポンス

<ResponseField name="items" type="Invite[]">
  <Expandable title="Invite">
    <ResponseField name="id" type="string">
      招待の一意識別子。
    </ResponseField>

    <ResponseField name="email" type="string">
      招待された人のメールアドレス。URL招待の場合はnullになることがあります。
    </ResponseField>

    <ResponseField name="code" type="string">
      招待コード。
    </ResponseField>

    <ResponseField name="role" type="string">
      招待された人に割り当てられた役割。`admin`、`member`のいずれか。
    </ResponseField>

    <ResponseField name="expiresAt" type="string">
      招待が期限切れになるISO8601タイムスタンプ。
    </ResponseField>

    <ResponseField name="createdAt" type="string">
      招待が作成されたISO8601タイムスタンプ。
    </ResponseField>

    <ResponseField name="isUrlInvite" type="boolean">
      URL招待かどうか。
    </ResponseField>

    <ResponseField name="folders" type="Folder[]">
      <Expandable title="Folder">
        <ResponseField name="id" type="string">
          フォルダID。
        </ResponseField>

        <ResponseField name="name" type="string">
          フォルダ名。
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="pagination" type="object">
  <ResponseField name="limit" type="number">
    返されたアイテムの数。
  </ResponseField>

  <ResponseField name="offset" type="number">
    スキップされたアイテムの数。
  </ResponseField>

  <ResponseField name="total" type="number">
    利用可能なアイテムの総数。
  </ResponseField>
</ResponseField>

<RequestExample>
  ```bash theme={null}
  curl --request GET \
    --url https://api.caret.so/v1/invites?limit=20&offset=0 \
    --header 'Authorization: Bearer <token>'
  ```
</RequestExample>

<ResponseExample>
  ```json theme={null}
  {
    "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
    }
  }
  ```
</ResponseExample>