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

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

Body

application/json

roleone ofOptional

Default role to set on newly invited members.

string · enumOptional

"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.

Possible values:

or

nullOptional

ssobooleanOptional

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

Responses

200

OK

application/json

usersstring[]Required

The unique identifiers of the users who were added to the organization

invitednumberRequired

The number of users who were added to the organization

failedSSOEmailsstring[]Optional

A list of emails who were invited to the organization, but who were not added as SSO users as they are members of another org

400

Bad Request

application/json

post

/orgs/{organizationId}/invites

HTTPcURLJavaScriptPython

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

{
  "emails": [
    "[e-mail]"
  ],
  "role": "admin",
  "sso": true
}

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

Join an organization with an invite

post

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

inviteIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

Responses

200

OK

application/json

objectOptional

post

/orgs/{organizationId}/invites/{inviteId}

HTTPcURLJavaScriptPython

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

200

OK

{}

List organization invites

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses

200

List of invite links in the organization.

application/json

get

/orgs/{organizationId}/link-invites

HTTPcURLJavaScriptPython

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",
      "redundant": true
    }
  ]
}

Create an organization invite

post

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

Body

application/json

or

or

Responses

201

The organization invite has been created

application/json

post

/orgs/{organizationId}/link-invites

HTTPcURLJavaScriptPython

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",
  "redundant": true
}

Get an organization by its ID

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

inviteIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

Responses

200

Invite link in the organization.

application/json

An invite link created in an organization

or

or

get

/orgs/{organizationId}/link-invites/{inviteId}

HTTPcURLJavaScriptPython

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",
  "redundant": true
}

Update an organization invite

patch

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

inviteIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

Body

application/json

or

Responses

200

The organization invite has been updated

application/json

An invite link created in an organization

or

or

patch

/orgs/{organizationId}/link-invites/{inviteId}

HTTPcURLJavaScriptPython

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",
  "redundant": true
}