Create Invite

curl --request POST \
  --url https://api.caret.so/v1/invites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "user@example.com",
  "role": "member",
  "isUrlInvite": false
}'

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

POST

invites

curl --request POST \
  --url https://api.caret.so/v1/invites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "user@example.com",
  "role": "member",
  "isUrlInvite": false
}'

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

Body

string

required

Email address of the person to invite.

string

default:"member"

Role to assign to the invitee. One of admin, member.

boolean

default:"false"

Whether to create a URL-based invite (true) or send an email invitation (false).

Response

object

Show Invite

string

Unique identifier for the invite.

string

Email address of the invitee.

string

Invite code.

string

Role assigned to the invitee.

string

ISO8601 timestamp when the invite expires.

string

ISO8601 timestamp when the invite was created.

boolean

Whether this is a URL-based invite.

curl --request POST \
  --url https://api.caret.so/v1/invites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "user@example.com",
  "role": "member",
  "isUrlInvite": false
}'

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

List Invites

Delete Invite

⌘I

​Body

​Response

Body

Response