Skip to main content
GET
/
v1
/
invites
curl --request GET \
  --url https://api.caret.so/v1/invites?limit=20&offset=0 \
  --header 'X-API-Key: <your_api_key>'

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

​
Query Parameters

​
limit
number
default:"20"
The number of items to return.
​
offset
number
default:"0"
The number of items to skip before starting to collect the result set.

​
Response

​
items
Invite[]
​
pagination
object
curl --request GET \
  --url https://api.caret.so/v1/invites?limit=20&offset=0 \
  --header 'X-API-Key: <your_api_key>'

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