GitBook APIs
Account Request URL
-Base Endpoint
https://openapi.xxx.com
Book
Get info about a book.
/books/{bookId}
bookId
Book
Update info about a book.
/books/{bookId}
bookId, title, subtitle, description, authors, translators, tags, published, language, cover, pages, isbn, price, publicationDate, saleStartDate, saleEndDate, visibility, status, isPublished, isTrashed, isPrivate, toc, chapterSortOrder, disableTableOfContents, disableNavigation, floatToc, enablePagefooter, showReferencedLabels, protected, isDownloadable, enableGitSync, gitRepo, gitUpstreamBranch, gitRemoteUpstreamUrl, gitRemoteBackupUrl
Book
Update info about a book.
/books/{bookId}
bookId, title, subtitle, description, authors, translators, tags, published, language, cover, pages, isbn, price, publicationDate, saleStartDate, saleEndDate, visibility, status, isPublished, isTrashed, isPrivate, toc, chapterSortOrder, disableTableOfContents, disableNavigation, floatToc, enablePagefooter, showReferencedLabels, protected, isDownloadable, enableGitSync, gitRepo, gitUpstreamBranch, gitRemoteUpstreamUrl, gitRemoteBackupUrl
Book
Delete a book.
/books/{bookId}
bookId
BookPage
Get info about a book page.
/books/{bookId}/pages/{id}
bookId, pageId
BookPage
Create a book page.
/books/{bookId}/pages
bookId, title, content, url, source, isUnlisted, chapterId, sort
BookPage
Update info about a book page.
/books/{bookId}/pages/{pageId}
bookId, pageId, title, content, url, source, isUnlisted, chapterId, sort
BookPage
Update info about a book page.
/books/{bookId}/pages/{pageId}
bookId, pageId, title, content, url, source, isUnlisted, chapterId, sort
BookPage
Delete a book page.
/books/{bookId}/pages/{pageId}
bookId, pageId
BookComment
Get info about a book comment.
/books/{bookId}/comments/{commentId}
bookId, commentId
BookComment
Create a book comment.
/books/{bookId}/comments
bookId, userId, content
BookComment
Update info about a book comment.
/books/{bookId}/comments/{commentId}
bookId, commentId, content
BookComment
Delete a book comment.
/books/{bookId}/comments/{commentId}
bookId, commentId
BookNote
Get info about a book note.
/books/{bookId}/notes/{noteId}
bookId, noteId
BookNote
Create a book note.
/books/{bookId}/notes
bookId, userId, content
BookNote
Update info about a book note.
/books/{bookId}/notes/{noteId}
bookId, noteId, content
BookNote
Delete a book note.
/books/{bookId}/notes/{noteId}
bookId, noteId
BookRating
Get info about a book rating.
/books/{bookId}/ratings/{userId}
bookId, userId
BookRating
Update info about a book rating.
/books/{bookId}/ratings/{userId}
bookId, userId, value
BookRating
Delete a book rating.
/books/{bookId}/ratings/{userId}
bookId, userId
BookLabel
Get info about a book label.
/books/{bookId}/labels/{labelId}
bookId, labelId
BookLabel
Create a book label.
/books/{bookId}/labels
bookId, name, color
BookLabel
Update info about a book label.
/books/{bookId}/labels/{labelId}
bookId, labelId, name, color
BookLabel
Delete a book label.
/books/{bookId}/labels/{labelId}
bookId, labelId
Chapter
Get info about a chapter.
/books/{bookId}/chapters/{chapterId}
bookId, chapterId
Chapter
Create a chapter.
/books/{bookId}/chapters
bookId, title, url, content, source, isUnlisted, sort
Chapter
Update info about a chapter.
/books/{bookId}/chapters/{chapterId}
bookId, chapterId, title, url, content, source, isUnlisted, sort
Chapter
Update info about a chapter.
/books/{bookId}/chapters/{chapterId}
bookId, chapterId, title, url, content, source, isUnlisted, sort
Chapter
Delete a chapter.
/books/{bookId}/chapters/{chapterId}
bookId, chapterId
User
Get info about a user.
/users/{userId}
userId
User
Create a user.
/users
name, email, password, avatar, signupToken
User
Update info about a user.
/users/{userId}
userId, name, email, role, avatar
User
Update info about a user.
/users/{userId}
userId, name, email, role, avatar
User
Delete a user.
/users/{userId}
userId
Group
Get info about a group.
/groups/{groupId}
groupId
Group
Create a group.
/groups
name, description, visibility, isPublic, members, admins, avatar, emailForInvite, language, settings
Group
Update info about a group.
/groups/{groupId}
groupId, name, description, visibility, isPublic, members, admins, avatar, emailForInvite, language, settings
Group
Update info about a group.
/groups/{groupId}
groupId, name, description, visibility, isPublic, members, admins, avatar, emailForInvite, language, settings
Group
Delete a group.
/groups/{groupId}
groupId
Team
Get info about a team.
/teams/{teamId}
teamId
Team
Create a team.
/teams
name, description, visibility, isPublic, members, admins, avatar, emailForInvite, language, settings
Team
Update info about a team.
/teams/{teamId}
teamId, name, description, visibility, isPublic, members, admins, avatar, emailForInvite, language, settings
Team
Update info about a team.
/teams/{teamId}
teamId, name, description, visibility, isPublic, members, admins, avatar, emailForInvite, language, settings
Team
Delete a team.
/teams/{teamId}
teamId
Collaboration
Get info about a collaboration.
/collaborations/{collaborationId}
collaborationId
Collaboration
Create a collaboration.
/collaborations
userId, bookId, role
Collaboration
Delete a collaboration.
/collaborations/{collaborationId}
collaborationId
Details
Provider
Country HQ
API Type
Categories
Alternatives
Important URLs
Last Updated on
Created At
Other Apps
Upskill for a better future
Want to start tracking API at scale?
Get updates about your favorite APIs and SDKs
We do our best to ensure that the data we release is complete, accurate, and useful. However, because we are not able to verify all the data, and because the processing required to make the data useful is complex, we cannot be held liable for omissions or inaccuracies.
