Create Invite

Invite Organization Member

curl --request POST \
  --url https://api.turso.tech/v1/organizations/{organizationSlug}/invites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "role": "member"
}
'

{
  "invited": {
    "ID": 1,
    "CreatedAt": "2023-01-01T00:00:00Z",
    "UpdatedAt": "2023-01-01T00:00:00Z",
    "DeletedAt": "2023-01-01T00:00:00Z",
    "Role": "member",
    "Email": "[email protected]",
    "OrganizationID": 1,
    "Token": "3e393245b91b41ebad0980bc98349c9d",
    "Organization": {
      "name": "turso",
      "slug": "turso",
      "type": "team",
      "overages": false,
      "blocked_reads": false,
      "blocked_writes": false
    },
    "Accepted": false
  }
}

POST

organizations

{organizationSlug}

invites

Invite Organization Member

curl --request POST \
  --url https://api.turso.tech/v1/organizations/{organizationSlug}/invites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "role": "member"
}
'

{
  "invited": {
    "ID": 1,
    "CreatedAt": "2023-01-01T00:00:00Z",
    "UpdatedAt": "2023-01-01T00:00:00Z",
    "DeletedAt": "2023-01-01T00:00:00Z",
    "Role": "member",
    "Email": "[email protected]",
    "OrganizationID": 1,
    "Token": "3e393245b91b41ebad0980bc98349c9d",
    "Organization": {
      "name": "turso",
      "slug": "turso",
      "type": "team",
      "overages": false,
      "blocked_reads": false,
      "blocked_writes": false
    },
    "Accepted": false
  }
}

If you want to invite someone who is already a registered Turso user, you can add them instead.

You must be an owner or admin to invite other users. You can only invite users to a team and not your personal account.

Authorizations

Authorization

string

header

required

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

Path Parameters

organizationSlug

string

required

The slug of the organization or user account.

Body

application/json

The user you want to invite to join Turso, and your organization.

string

required

The email of the user you want to invite.

role

enum<string>

default:member

The role given to the user.

Available options:

admin,

member,

viewer

Response

200 - application/json

Successful response

invited

object

Show child attributes

invited.ID

integer

The unique ID for the invite.

Example:

1

invited.CreatedAt

string

The datetime the invite was created in ISO 8601 format. Example: 2023-01-01T00:00:00Z

Example:

"2023-01-01T00:00:00Z"

invited.UpdatedAt

string

The datetime the invite was updated in ISO 8601 format. Example: 2023-01-01T00:00:00Z

Example:

"2023-01-01T00:00:00Z"

invited.DeletedAt

string

The datetime the invite was deleted (or revoked) in ISO 8601 format. Example: 2023-01-01T00:00:00Z

Example:

"2023-01-01T00:00:00Z"

invited.Role

enum<string>

The assigned role for the invited user.

Available options:

admin,

member,

viewer

Example:

"member"

invited.Email

string

The email of the person invited.

Example:

"[email protected]"

invited.OrganizationID

integer

The ID of the organization the user was invited to.

Example:

1

invited.Token

string

The unique token used to verify the invite.

Example:

"3e393245b91b41ebad0980bc98349c9d"

invited.Organization

object

Show child attributes

invited.Organization.name

string

The organization name. Every user has a personal organization for their own account.

Example:

"personal"

invited.Organization.slug

string

The organization slug. This will be your username for personal accounts.

Example:

"iku"

invited.Organization.type

enum<string>

The type of account this organization is. Will always be personal or team.

Available options:

personal,

team

Example:

"personal"

invited.Organization.overages

boolean

The name of the organization. Every user has a personal organization for their own account.

Example:

false

invited.Organization.blocked_reads

boolean

Returns the current status for blocked reads.

Example:

false

invited.Organization.blocked_writes

boolean

Returns the current status for blocked writes.

Example:

false

invited.Organization.plan_id

string

The pricing plan identifier this organization is subscribed to.

Example:

"developer"

invited.Organization.plan_timeline

string

The billing cycle for the paid plan, if any.

Example:

"monthly"

invited.Organization.platform

string

The external platform this organization is managed by. Will be empty for Turso managed organizations.

Example:

"vercel"

Example:

{
  "name": "turso",
  "slug": "turso",
  "type": "team",
  "overages": false,
  "blocked_reads": false,
  "blocked_writes": false
}

invited.Accepted

boolean

The current status of the invite.

Example:

false

List Delete Invite

⌘I

Turso Cloud

SDKs

CLI

API Reference

Create Invite

Authorizations

Path Parameters

Body

Response