Category
References (REST API v1)
References (REST API v1)
REST API v1
Find out how to access resources in Documents feature via REST API.
Changelog
List of any changes to the REST API.
Model Specification
Space A space is a top-level entity that contains every other resources that are managed in the Documents feature. Field Name Type Required? Description Example id string Y id is the unique identifier of the space. "1" channelId string Y channelId is the unique identifier of the channel that the space belongs to. "1" createdAt number Y createdAt is the timestamp when the space was created in epoch milliseconds. 1704067200000 updatedAt number Y updatedAt is the timestamp when the space was last u
Blocks Specification
Find out details about Blocks model, the rich text content format used in Documents.
Articles
Get an Article by ID and language Property Description Method GET Path /open/v1/spaces/$me/articles/{articleId} Accept - Content-Type application/json Description Retrieves an article from its current revision in the requested language by article ID and language. - Request - Query Param Required? Default Type Description Example language O - string Requested language ko - Body // (empty) - Response type ArticleView = { article: Article articleCategory?: { articleId: string category: Category } a
Articles & Revisions Management
Management APIs can create new articles and revisions, or modify existing contents.
Authors
Get an Author Property Description Method GET Path /open/v1/spaces/$me/authors/{authorId} Accept - Content-Type application/json Description Retrieves an author by its ID. - Request - Query (empty) - Body // (empty) - Response type AuthorView = { author: Author } Batch Get Authors Property Description Method GET Path /open/v1/spaces/$me/authors/batch Accept - Content-Type application/json Description Retrieves multiple authors by IDs. Can fetch up to 25 authors. - Request - Query Param Required?
Categories
Get a Category Property Description Method GET Path /open/v1/spaces/$me/categories/{categoryId} Accept - Content-Type application/json Description Retrieves a category by its ID. - Request - Query (empty) - Body // (empty) - Response type CategoryView = { category: Category } Get a Category by Slug Property Description Method GET Path /open/v1/spaces/$me/categories/${slug} Accept - Content-Type application/json Description Retrieves a category by its slug. - Request - Query (empty) - Body // (em
Miscellaneous
Load Supported Languages from System Property Description Method GET Path /open/v1/languages Accept - Content-Type application/json Description Views the list of supported languages in the Documents feature. (Currently,we support 33 languages) - Request - Query (empty) - Body // (empty) - Response type AvailableLanguagesView = { languages: Language[] }
Navigation
Load Full Navigation of a Space Property Description Method GET Path /open/v1/spaces/$me/nav-nodes/$all Accept - Content-Type application/json Description Loads all navigation nodes in the space's navigation tree. - Request - Query (empty) - Body // (empty) - Response type NavNodesAllView = { navNodes: NavNode[] } Load the path to a Navigation Node from Root Property Description Method GET Path /open/v1/spaces/$me/nav-nodes/{navNodeId}/$path Accept - Content-Type application/json Description Vie
Revisions
Get a Revision by Article ID and Revision ID Property Description Method GET Path /open/v1/spaces/$me/articles/{articleId}/revisions/{revisionId} Accept - Content-Type application/json Description Retrieves a revision of an article specified by article and revision ID. - Request - Query (empty) - Body // (empty) - Response type RevisionView = { revision: Revision author: Author } Batch Get Revisions by Article ID and Revision IDs Property Description Method GET Path /open/v1/spaces/$me/articles/
Spaces
Get a Space Property Description Method GET Path /open/v1/spaces/$me Accept - Content-Type application/json Description Retrieves a space. - Request - Query (empty) - Body // (empty) - Response type SpaceView = { space: Space }
Topics
Get a Topic Property Description Method GET Path /open/v1/spaces/$me/topics/{topicId} Accept - Content-Type application/json Description Retrieves a topic by its ID. - Request - Query (empty) - Body // (empty) - Response type TopicView = { topic: Topic } Batch Get a Topic Property Description Method GET Path /open/v1/spaces/$me/topics/batch Accept - Content-Type application/json Description Retrieves multiple topics by IDs.Can fetch up to 25 topics at once. - Request - Query Param Required? Defa