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

objectoptional

application/json

post

POST /v1/orgs/{organizationId}/invites HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "emails": [
    "text"
  ],
  "role": "admin",
  "sso": true
}

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

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

objectoptional

post

POST /v1/orgs/{organizationId}/invites/{inviteId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{}

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

all ofoptional

get

GET /v1/orgs/{organizationId}/link-invites HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

List of invite links in the organization.

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

Create an organization invite

post

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

Body

one ofoptional

Responses

application/json

one ofoptional

An invite link created in an organization

An invite link to an organization

An invite link to a specific space in an organization

An invite link to a specific collection in an organization

post

POST /v1/orgs/{organizationId}/link-invites HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "role": "admin"
}

201

The organization invite has been created

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

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

one ofoptional

An invite link created in an organization

An invite link to an organization

An invite link to a specific space in an organization

An invite link to a specific collection in an organization

get

GET /v1/orgs/{organizationId}/link-invites/{inviteId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Invite link in the organization.

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

Deletes an organization invite.

delete

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

inviteIdstringrequired

The unique id of the invite

Responses

delete

DELETE /v1/orgs/{organizationId}/link-invites/{inviteId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

205

The organization invite has been deleted

No Content

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

one ofoptional

An invite link created in an organization

An invite link to an organization

An invite link to a specific space in an organization

An invite link to a specific collection in an organization

patch

PATCH /v1/orgs/{organizationId}/link-invites/{inviteId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "role": "admin"
}

200

The organization invite has been updated

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

Was this helpful?