Copy
Ask AI
curl --request POST \
--url https://api.caret.so/v1/invites \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"email": "[email protected]",
"role": "member",
"isUrlInvite": false
}'
Copy
Ask AI
{
"invite": {
"id": "inv_123",
"email": "[email protected]",
"code": "abc123xy",
"role": "member",
"expiresAt": "2026-02-27T10:00:00Z",
"createdAt": "2026-01-28T10:00:00Z",
"isUrlInvite": false
}
}
Invites
Create Invite
Create a new invite for the workspace
POST
/
v1
/
invites
Copy
Ask AI
curl --request POST \
--url https://api.caret.so/v1/invites \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"email": "[email protected]",
"role": "member",
"isUrlInvite": false
}'
Copy
Ask AI
{
"invite": {
"id": "inv_123",
"email": "[email protected]",
"code": "abc123xy",
"role": "member",
"expiresAt": "2026-02-27T10:00:00Z",
"createdAt": "2026-01-28T10:00:00Z",
"isUrlInvite": false
}
}
Body
Email address of the person to invite.
Role to assign to the invitee. One of
admin, member.Whether to create a URL-based invite (
true) or send an email invitation
(false).Response
Show Invite
Show Invite
Unique identifier for the invite.
Email address of the invitee.
Invite code.
Role assigned to the invitee.
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 POST \
--url https://api.caret.so/v1/invites \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"email": "[email protected]",
"role": "member",
"isUrlInvite": false
}'
Copy
Ask AI
{
"invite": {
"id": "inv_123",
"email": "[email protected]",
"code": "abc123xy",
"role": "member",
"expiresAt": "2026-02-27T10:00:00Z",
"createdAt": "2026-01-28T10:00:00Z",
"isUrlInvite": false
}
}
⌘I