HTTP API
ReferenceWorkspace API
Endpoints for announcements, references to workspace items, and searching the knowledge the caller can read.
This group covers announcements, resolving and searching references to the workspace's items, and searching the knowledge the caller can read. Every call acts as a person: send a personal access token, or an OAuth access token from a person's sign-in (scope Volobox). An integration app's own client secret is refused with 403 (Volobox:Integrations:MemberConnectionRequired). Paths, tokens and conventions are in API overview.
Announcements
Request bodies:
CreateAnnouncementDto(create): requirestitle(string).UpdateAnnouncementDto(update): requirestitle(string).
Item references
Knowledge search
Example
workspace.announcement.getList: lists the announcements the caller can see, filtered and paged.
curl -s "https://volobox.example.com/api/v1/announcement?SkipCount=0&MaxResultCount=20" \
-H "Authorization: Bearer $VOLOBOX_TOKEN"SkipCount is how many items to skip and MaxResultCount how many to return. The answer carries totalCount and the page of items.