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.
The unique id of the organization
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.
If true, invites the user as an SSO user of the organization. Defaults to false.
OK
Bad Request
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"
]
}The unique id of the organization
The unique id of the invite
OK
POST /v1/orgs/{organizationId}/invites/{inviteId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{}The unique id of the organization
Identifier of the page results to fetch.
The number of results per page
List of invite links in the organization.
GET /v1/orgs/{organizationId}/link-invites HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
List of invite links in the organization.
{
"next": {
"page": "text"
},
"count": 1,
"items": [
{
"object": "invite",
"id": "text",
"role": "admin",
"redundant": true
}
]
}The unique id of the organization
The organization invite has been created
An invite link created in an organization
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"
}The organization invite has been created
{
"object": "invite",
"id": "text",
"role": "admin",
"redundant": true
}The unique id of the organization
The unique id of the invite
Invite link in the organization.
An invite link created in an organization
GET /v1/orgs/{organizationId}/link-invites/{inviteId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Invite link in the organization.
{
"object": "invite",
"id": "text",
"role": "admin",
"redundant": true
}The unique id of the organization
The unique id of the invite
The organization invite has been updated
An invite link created in an organization
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"
}The organization invite has been updated
{
"object": "invite",
"id": "text",
"role": "admin",
"redundant": true
}Last updated
Was this helpful?