Copy
Ask AI
curl --request GET \
--url https://api.caret.so/v1/invites?limit=20&offset=0 \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
{
"items": [
{
"id": "inv_123",
"email": "[email protected]",
"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
}
}
Invites
List Invites
Get a paginated list of all pending invites for the workspace
GET
/
v1
/
invites
Copy
Ask AI
curl --request GET \
--url https://api.caret.so/v1/invites?limit=20&offset=0 \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
{
"items": [
{
"id": "inv_123",
"email": "[email protected]",
"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
}
}
Query Parameters
The number of items to return.
The number of items to skip before starting to collect the result set.
Response
Show Invite
Show Invite
Unique identifier for the invite.
Email address of the invitee. Can be null for URL-based invites.
Invite code.
Role assigned to the invitee. One of
admin, member.ISO8601 timestamp when the invite expires.
ISO8601 timestamp when the invite was created.
Whether this is a URL-based invite.
Copy
Ask AI
curl --request GET \
--url https://api.caret.so/v1/invites?limit=20&offset=0 \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
{
"items": [
{
"id": "inv_123",
"email": "[email protected]",
"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
}
}
⌘I