Invite Team Member sends an invitation to join the team (checks seat limit)

POST/v1/auth/invite

Base URL *

Your instance endpoint, shown on the instance page in the dashboard. Each instance has its own host; there is no shared API host.

Authorization (Bearer token)

Request Body (JSON)

Request Body

Property	Type	Required	Description
`email`	`string`	No
`role`	`"ORGANIZATION_ROLE_UNSPECIFIED" \| "ORGANIZATION_ROLE_OWNER" \| "ORGANIZATION_ROLE_ADMIN" \| "ORGANIZATION_ROLE_MEMBER" \| "ORGANIZATION_ROLE_VIEWER"`	No

Responses

200 Invitation result

Property	Type	Description
`success`	`boolean`
`invitation`	`object`
`upgradeMessage`	`string`

default An unexpected error response.

Property	Type	Description
`code`	`integer`
`message`	`string`
`details`	`object[]`

Request

curl -X POST "http://localhost:8089/v1/auth/invite" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"string","role":"ORGANIZATION_ROLE_UNSPECIFIED"}'

const response = await fetch("http://localhost:8089/v1/auth/invite", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "email": "string",
  "role": "ORGANIZATION_ROLE_UNSPECIFIED"
}),
});
const data = await response.json();

import requests

response = requests.post(
    "http://localhost:8089/v1/auth/invite",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    json={
  "email": "string",
  "role": "ORGANIZATION_ROLE_UNSPECIFIED"
},
)
data = response.json()

Response

{
  "success": true,
  "invitation": {
    "id": "string",
    "email": "string",
    "role": "ORGANIZATION_ROLE_UNSPECIFIED",
    "invitedByEmail": "string",
    "expiresAt": "2024-01-01T00:00:00Z",
    "createdAt": "2024-01-01T00:00:00Z",
    "accepted": true
  },
  "upgradeMessage": "string"
}

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}