> ## 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.

# List Invites

> Get a paginated list of all pending invites for the workspace

### Query Parameters

<ParamField query="limit" type="number" default="20">
  The number of items to return.
</ParamField>

<ParamField query="offset" type="number" default="0">
  The number of items to skip before starting to collect the result set.
</ParamField>

### Response

<ResponseField name="items" type="Invite[]">
  <Expandable title="Invite">
    <ResponseField name="id" type="string">
      Unique identifier for the invite.
    </ResponseField>

    <ResponseField name="email" type="string">
      Email address of the invitee. Can be null for URL-based invites.
    </ResponseField>

    <ResponseField name="code" type="string">
      Invite code.
    </ResponseField>

    <ResponseField name="role" type="string">
      Role assigned to the invitee. One of `admin`, `member`.
    </ResponseField>

    <ResponseField name="expiresAt" type="string">
      ISO8601 timestamp when the invite expires.
    </ResponseField>

    <ResponseField name="createdAt" type="string">
      ISO8601 timestamp when the invite was created.
    </ResponseField>

    <ResponseField name="isUrlInvite" type="boolean">
      Whether this is a URL-based invite.
    </ResponseField>

    <ResponseField name="folders" type="Folder[]">
      <Expandable title="Folder">
        <ResponseField name="id" type="string">
          Folder ID.
        </ResponseField>

        <ResponseField name="name" type="string">
          Folder name.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="pagination" type="object">
  <Expandable title="Pagination">
    <ResponseField name="limit" type="number">
      Number of items per page.
    </ResponseField>

    <ResponseField name="nextOffset" type="number | null">
      Offset for the next page, null if last page.
    </ResponseField>

    <ResponseField name="isLast" type="boolean">
      Whether this is the last page.
    </ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash theme={null}
  curl --request GET \
    --url https://api.caret.so/v1/invites?limit=20&offset=0 \
    --header 'Authorization: Bearer <your_api_key>'
  ```
</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,
      "nextOffset": null,
      "isLast": true
    }
  }
  ```
</ResponseExample>