Organization invites

Streamline the invitation process for new members joining your organization.

Use this API to create and revoke invitations for new members. By automating invite flows, you can maintain a cohesive onboarding experience for collaborators and speed up team expansion.

Invite users in an organization

post

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

Body

emailsone of[]required

roleone ofoptional

Default role to set on newly invited members.

"The role of a member in an organization. "admin": Can administrate the content: create, delete spaces, ... "create": Can create content. "review": Can review content. "edit": Can edit the content (live or change requests). "comment": Can access the content and its discussions. "read": Can access the content, but cannot update it in any way.

ssobooleanoptional

If true, invites the user as an SSO user of the organization. Defaults to false.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.gitbook.com/v1/orgs/{organizationId}/invites' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "emails": [
      "text"
    ],
    "role": "admin",
    "sso": true
  }'

200

400

200

{
  "users": [
    "text"
  ],
  "invited": 1,
  "failedSSOEmails": [
    "text"
  ]
}

OK

Join an organization with an invite

post

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

inviteIdstringrequired

The unique id of the invite

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.gitbook.com/v1/orgs/{organizationId}/invites/{inviteId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{}

OK

List organization invites

get

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

Query parameters

pagestringoptional

Identifier of the page results to fetch.

limitnumber · max: 1000optional

The number of results per page

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.gitbook.com/v1/orgs/{organizationId}/link-invites' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "invite",
      "id": "text",
      "role": "admin"
    }
  ]
}

List of invite links in the organization.

Create an organization invite

post

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

Body

one ofoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.gitbook.com/v1/orgs/{organizationId}/link-invites' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "role": "admin"
  }'

201

201

{
  "object": "invite",
  "id": "text",
  "role": "admin"
}

The organization invite has been created

Get an organization by its ID

get

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

inviteIdstringrequired

The unique id of the invite

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.gitbook.com/v1/orgs/{organizationId}/link-invites/{inviteId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "object": "invite",
  "id": "text",
  "role": "admin"
}

Invite link in the organization.

Deletes an organization invite.

delete

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

inviteIdstringrequired

The unique id of the invite

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.gitbook.com/v1/orgs/{organizationId}/link-invites/{inviteId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

205

205

No Content

The organization invite has been deleted

Update an organization invite

patch

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

inviteIdstringrequired

The unique id of the invite

Body

one ofoptional

Update role of an organization invite

Update level of an organization content invite

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.gitbook.com/v1/orgs/{organizationId}/link-invites/{inviteId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "role": "admin"
  }'

200

200

{
  "object": "invite",
  "id": "text",
  "role": "admin"
}

The organization invite has been updated