Skip to main content
POST
/
base
/
{baseId}
/
invitation
/
link
cURL
curl --request POST \
  --url https://app.teable.ai/api/base/%7BbaseId%7D/invitation/link \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"role":"creator"}'
{
  "invitationId": "<string>",
  "inviteUrl": "<string>",
  "invitationCode": "<string>",
  "createdBy": "<string>",
  "createdTime": "<string>",
  "role": "creator"
}

Documentation Index

Fetch the complete documentation index at: https://help.teable.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
baseId
string
required

Body

application/json
​
role
enum<string>
required
Available options:
creator,
editor,
commenter,
viewer

Response

201 - application/json

Successful response, return the ID of the invitation link.

​
invitationId
string
required
​
inviteUrl
string
required
​
invitationCode
string
required
​
createdBy
string
required
​
createdTime
string
required
​
role
enum<string>
required
Available options:
creator,
editor,
commenter,
viewer
Last modified on March 5, 2026