Workspaces
API endpoints related to workspaces.
GET /workspaces
Gets workspaces that are accessible to the current user, paginated. The nextPageCursor is returned in order to get the next page of workspaces if there are more to return.
Query Parameters
- nextPageCursor — Optional — string
-
The display_title and wikiid of the page of workspaces to return.
|
Response
Status: 200 OK
{ "items": [ { "data": { "workspaceRevisionid": 123, "wikiid": 456, "status": "enabled", "privacyStatus": "private", "wiki": { "url": "\/c\/TestCategory", "fullUrl": "https:\/\/example.com\/c\/TestCategory", "editUrl": "\/c\/Edit\/TestCategory", "wikiid": 456, "langid": "en", "namespace": "CATEGORY", "title": "Test Category", "revisionid": 4, "contents_raw": "", "contents_json": { "type": "doc", "content": [] }, "contents_rendered": "", "can_edit": true, "author": [], "flags": [], "image": null, "documents": [], "display_title": "Test Category", "ancestors": [], "description": "", "children": [], "category_lists": [], "featured_guides": [], "guides": [], "favorited_guide_ids": [], "related_wikis": [], "repairability_score": null, "category_info": [], "source_revisionid": null, "info": [] }, "user": { "userid": 4, "banned": null, "username": "Some User", "unique_username": "someuser", "join_date": 1750272266, "image": { "id": 789, "guid": "SdCOHYQlSb3GiH1P", "original": "https:\/\/example.com\/images\/single-avatar-2-09", "mini": "https:\/\/example.com\/images\/single-avatar-2-09.mini", "thumbnail": "https:\/\/example.com\/images\/single-avatar-2-09.thumbnail", "140x105": "https:\/\/example.com\/images\/single-avatar-2-09.140x105", "200x150": "https:\/\/example.com\/images\/single-avatar-2-09.200x150", "standard": "https:\/\/example.com\/images\/single-avatar-2-09.standard", "440x330": "https:\/\/example.com\/images\/single-avatar-2-09.440x330", "medium": "https:\/\/example.com\/images\/single-avatar-2-09.medium", "large": "https:\/\/example.com\/images\/single-avatar-2-09.large" }, "reputation": 1, "url": "https:\/\/example.com\/User\/4\/someuser", "teams": [], "enabled": true } } } ], "pageSize": 10, "nextPageCursor": "Test Category|456" }
GET /workspaces/{wikiid}
Get a workspace by its wikiid. The workspace must be accessible to the current user.
Response
Status: 200 OK
{ "workspaceRevisionid": 123, "wikiid": 456, "status": "enabled", "privacyStatus": "private", "wiki": { "url": "\/c\/TestCategory", "fullUrl": "https:\/\/example.com\/c\/TestCategory", "editUrl": "\/c\/Edit\/TestCategory", "wikiid": 456, "langid": "en", "namespace": "CATEGORY", "title": "Test Category", "revisionid": 4, "contents_raw": "", "contents_json": { "type": "doc", "content": [] }, "contents_rendered": "", "can_edit": true, "author": [], "flags": [], "image": null, "documents": [], "display_title": "Test Category", "ancestors": [], "description": "", "children": [], "category_lists": [], "featured_guides": [], "guides": [], "favorited_guide_ids": [], "related_wikis": [], "repairability_score": null, "category_info": [], "source_revisionid": null, "info": [] }, "user": { "userid": 4, "banned": null, "username": "Some User", "unique_username": "someuser", "join_date": 1750272266, "image": { "id": 789, "guid": "SdCOHYQlSb3GiH1P", "original": "https:\/\/example.com\/images\/single-avatar-2-09", "mini": "https:\/\/example.com\/images\/single-avatar-2-09.mini", "thumbnail": "https:\/\/example.com\/images\/single-avatar-2-09.thumbnail", "140x105": "https:\/\/example.com\/images\/single-avatar-2-09.140x105", "200x150": "https:\/\/example.com\/images\/single-avatar-2-09.200x150", "standard": "https:\/\/example.com\/images\/single-avatar-2-09.standard", "440x330": "https:\/\/example.com\/images\/single-avatar-2-09.440x330", "medium": "https:\/\/example.com\/images\/single-avatar-2-09.medium", "large": "https:\/\/example.com\/images\/single-avatar-2-09.large" }, "reputation": 1, "url": "https:\/\/example.com\/User\/4\/someuser", "teams": [], "enabled": true } }
POST /workspaces
Create a new workspace. The workspace will be created at the root level of the site with the specified access status.
Request Body
- workspaceTitle — Required — string
-
The title of the workspace to create.
- accessStatus — Required — enum
-
The primary access strategy for the workspace. Everyone on the site may access a public workspace by default, whereas private workspaces are only accessible by teams and users with granted permissions.
Possible Values:
- public
- private
Response
Status: 200 OK
{ "workspaceRevisionid": 123, "wikiid": 456, "status": "enabled", "privacyStatus": "private", "wiki": { "url": "\/c\/TestCategory", "fullUrl": "https:\/\/example.com\/c\/TestCategory", "editUrl": "\/c\/Edit\/TestCategory", "wikiid": 456, "langid": "en", "namespace": "CATEGORY", "title": "Test Category", "revisionid": 4, "contents_raw": "", "contents_json": { "type": "doc", "content": [] }, "contents_rendered": "", "can_edit": true, "author": [], "flags": [], "image": null, "documents": [], "display_title": "Test Category", "ancestors": [], "description": "", "children": [], "category_lists": [], "featured_guides": [], "guides": [], "favorited_guide_ids": [], "related_wikis": [], "repairability_score": null, "category_info": [], "source_revisionid": null, "info": [] }, "user": { "userid": 4, "banned": null, "username": "Some User", "unique_username": "someuser", "join_date": 1750272266, "image": { "id": 789, "guid": "SdCOHYQlSb3GiH1P", "original": "https:\/\/example.com\/images\/single-avatar-2-09", "mini": "https:\/\/example.com\/images\/single-avatar-2-09.mini", "thumbnail": "https:\/\/example.com\/images\/single-avatar-2-09.thumbnail", "140x105": "https:\/\/example.com\/images\/single-avatar-2-09.140x105", "200x150": "https:\/\/example.com\/images\/single-avatar-2-09.200x150", "standard": "https:\/\/example.com\/images\/single-avatar-2-09.standard", "440x330": "https:\/\/example.com\/images\/single-avatar-2-09.440x330", "medium": "https:\/\/example.com\/images\/single-avatar-2-09.medium", "large": "https:\/\/example.com\/images\/single-avatar-2-09.large" }, "reputation": 1, "url": "https:\/\/example.com\/User\/4\/someuser", "teams": [], "enabled": true } }
POST /workspaces/convert/from-category/{wikiid}
Convert an existing category to a workspace. The category will be moved to the root level of the site.
Query Parameters
- wikiid — Required — integer
-
The wikiid of the category to convert.
Request Body
- accessStatus — Required — enum
-
The primary access strategy for the workspace. Everyone on the site may access a public workspace by default, whereas private workspaces are only accessible by teams and users with granted permissions.
Possible Values:
- public
- private
Response
Status: 200 OK
{ "workspaceRevisionid": 123, "wikiid": 456, "status": "enabled", "privacyStatus": "private", "wiki": { "url": "\/c\/TestCategory", "fullUrl": "https:\/\/example.com\/c\/TestCategory", "editUrl": "\/c\/Edit\/TestCategory", "wikiid": 456, "langid": "en", "namespace": "CATEGORY", "title": "Test Category", "revisionid": 4, "contents_raw": "", "contents_json": { "type": "doc", "content": [] }, "contents_rendered": "", "can_edit": true, "author": [], "flags": [], "image": null, "documents": [], "display_title": "Test Category", "ancestors": [], "description": "", "children": [], "category_lists": [], "featured_guides": [], "guides": [], "favorited_guide_ids": [], "related_wikis": [], "repairability_score": null, "category_info": [], "source_revisionid": null, "info": [] }, "user": { "userid": 4, "banned": null, "username": "Some User", "unique_username": "someuser", "join_date": 1750272266, "image": { "id": 789, "guid": "SdCOHYQlSb3GiH1P", "original": "https:\/\/example.com\/images\/single-avatar-2-09", "mini": "https:\/\/example.com\/images\/single-avatar-2-09.mini", "thumbnail": "https:\/\/example.com\/images\/single-avatar-2-09.thumbnail", "140x105": "https:\/\/example.com\/images\/single-avatar-2-09.140x105", "200x150": "https:\/\/example.com\/images\/single-avatar-2-09.200x150", "standard": "https:\/\/example.com\/images\/single-avatar-2-09.standard", "440x330": "https:\/\/example.com\/images\/single-avatar-2-09.440x330", "medium": "https:\/\/example.com\/images\/single-avatar-2-09.medium", "large": "https:\/\/example.com\/images\/single-avatar-2-09.large" }, "reputation": 1, "url": "https:\/\/example.com\/User\/4\/someuser", "teams": [], "enabled": true } }