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

roleone ofOptional

Default role to set on newly invited members.

string · enum | nullableOptional

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

ssobooleanOptional

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

Responses

200

OK

application/json

400

Bad Request

application/json

post

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: 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

200

OK

application/json

Responseobject

post

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

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

200

List of invite links in the organization.

application/json

Responseall of

get

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

Path parameters

organizationIdstringRequired

The unique id of the organization

Body

one ofOptional

or

or

Responses

201

The organization invite has been created

application/json

Responseone of

An invite link created in an organization

or

or

post

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

Path parameters

organizationIdstringRequired

The unique id of the organization

inviteIdstringRequired

The unique id of the invite

Responses

200

Invite link in the organization.

application/json

Responseone of

An invite link created in an organization

or

or

get

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
}

Deletes an organization invite.

delete

Authorizations

Path parameters

organizationIdstringRequired

The unique id of the organization

inviteIdstringRequired

The unique id of the invite

Responses

205

The organization invite has been deleted

delete

HTTPcURLJavaScriptPython

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

or

Responses

200

The organization invite has been updated

application/json

Responseone of

An invite link created in an organization

or

or

patch

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
}