HTTP API

Reference

Workspace 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

GET/api/v1/announcement
Lists the announcements the caller can see, filtered and paged.
workspace.announcement.getList
POST/api/v1/announcement
Creates an announcement for the whole workspace or a chosen audience.
workspace.announcement.create
GET/api/v1/announcement/{id}
Gets an announcement the caller can see.
workspace.announcement.get
PUT/api/v1/announcement/{id}
Updates an announcement the caller may manage.
workspace.announcement.update
DELETE/api/v1/announcement/{id}
Deletes an announcement the caller may manage.
workspace.announcement.delete
POST/api/v1/announcement/{id}/confirm-read
Confirms that the caller read an announcement that asks for a read confirmation.
workspace.announcement.confirmRead
POST/api/v1/announcement/{id}/mark-page-read
Records that the caller read an announcement that asks for no reaction.
workspace.announcement.markPageRead
GET/api/v1/announcement/{id}/reaction-stats
Gets how the audience of an announcement has responded to it: reads, read confirmations or poll answers.
workspace.announcement.getReactionStats
POST/api/v1/announcement/poll-vote/{id}
Records the caller's answer to an announcement's poll.
workspace.announcement.submitPollVote

Request bodies:

  • CreateAnnouncementDto (create): requires title (string).
  • UpdateAnnouncementDto (update): requires title (string).

Item references

POST/api/v1/entity-reference/resolve-batch
Resolves reference tokens to the items they name (title, kind and link), marking the ones the caller cannot open as restricted.
workspace.entityReference.resolveBatch
GET/api/v1/entity-reference/search
Searches the items the caller can reference (tasks, pages, files, people and more) by name.
workspace.entityReference.search
GET/api/v1/knowledge/search
Searches the workspace's indexed knowledge the caller can read and returns the best-matching passages.
workspace.knowledge.search

Example

workspace.announcement.getList: lists the announcements the caller can see, filtered and paged.

curl
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.