GitBook methods

Learn about the available methods from the GitBook client library

Search

The following methods can be found on the client.search object.

Method
searchContent()
askQuery()

User

The following methods can be found on the client.user object.

Method
getAuthenticatedUser()
listSpacesForAuthenticatedUser()

Users

The following methods can be found on the client.users object.

Method
getUserById()

Spaces

The following methods can be found on the client.spaces object.

Method
getSpaceById()
searchSpaceContent()
askQueryInSpace()
importGitRepository()
exportToGitRepository()
getContentAnalyticsForSpaceById()
getSearchAnalyticsForSpaceById()
getTrafficAnalyticsForSpaceById()
trackViewInSpaceById()
getCurrentRevision()
importContent()
listFiles()
getPageById()
importContentInPageById()
getPageByPath()
createChangeRequest()
mergeChangeRequest()
updateChangeRequest()
getRevisionOfChangeRequestById()
importContentInChangeRequest()
listFilesInChangeRequestById()
getPageInChangeRequestById()
importContentInChangeRequestPageById()
getPageInChangeRequestByPath()
getRevisionById()
listFilesInRevisionById()
getPageInRevisionById()
getPageInRevisionByPath()
listPermissionsAggregateInSpace()

Collections

The following methods can be found on the client.collections object.

Method
getCollectionById()
listSpacesInCollectionById()
listPermissionsAggregateInCollection()

Integrations

The following methods can be found on the client.integrations object.

Method
listIntegrations()
getIntegrationByName()
publishIntegration()
unpublishIntegration()
listIntegrationInstallations()
listIntegrationSpaceInstallations()
renderIntegrationUiWithGet()
renderIntegrationUiWithPost()
updateIntegrationInstallation()
createIntegrationInstallationToken()
updateIntegrationSpaceInstallation()

Orgs

The following methods can be found on the client.orgs object.

Method
listOrganizationsForAuthenticatedUser()
listMembersInOrganizationById()
getMemberInOrganizationById()
updateMemberInOrganizationById()
removeMemberFromOrganizationById()
setUserAsSsoMemberForOrganization()
listSpacesForOrganizationMember()
listTeamsInOrganizationById()
createOrganizationTeam()
getTeamInOrganizationById()
updateTeamInOrganizationById()
removeTeamFromOrganizationById()
updateMembersInOrganizationTeam()
listTeamMembersInOrganizationById()
addMemberToOrganizationTeamById()
deleteMemberFromOrganizationTeamById()
inviteUsersToOrganization()
joinOrganizationWithInvite()
upgradeOrganizationPlan()
getOrganizationBillingPortal()
requestOrganizationUpgrade()
transferOrganization()
searchOrganizationContent()
listSpacesInOrganizationById()
listCollectionsInOrganizationById()
setupDirectorySync()
listDirectorySyncGroups()
syncDirectorySyncGroupsToTeams()

Urls

The following methods can be found on the client.urls object.

Method
getContentByUrl()