HTTP API

Reference

Agenda API

Endpoints for the caller's agenda: agenda items, recurring agenda items and the agenda requests people send each other.

This group covers the caller's agenda: agenda items and the tasks, requests and other items they link to, recurring agenda items, and the agenda requests people send each other. 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.

Agenda items

GET/api/v1/agenda-item
Lists the caller's agenda items for a date range.
agenda.agendaItem.getList
POST/api/v1/agenda-item
Creates an agenda item for the caller.
agenda.agendaItem.create
GET/api/v1/agenda-item/{id}
Gets one of the caller's agenda items.
agenda.agendaItem.get
PUT/api/v1/agenda-item/{id}
Changes an agenda item's title, date, time or other fields.
agenda.agendaItem.update
DELETE/api/v1/agenda-item/{id}
Deletes an agenda item.
agenda.agendaItem.delete
POST/api/v1/agenda-item/{id}/convert-to-recurring
Turns an agenda item into a recurring one.
agenda.agendaItem.convertToRecurring
POST/api/v1/agenda-item/{id}/create-task
Creates a task in a project from an agenda item and links the two.
agenda.agendaItem.createTaskFromAgendaItem
POST/api/v1/agenda-item/{id}/links
Links an agenda item to a task, request or other item.
agenda.agendaItem.addLink
DELETE/api/v1/agenda-item/{id}/links/{linkId}
Removes a link from an agenda item.
agenda.agendaItem.unlink
POST/api/v1/agenda-item/{id}/move-scheduled
Moves a scheduled agenda item to another day at the same time of day.
agenda.agendaItem.moveScheduledItem
POST/api/v1/agenda-item/{id}/set-status
Sets the status of an agenda item.
agenda.agendaItem.setStatus
POST/api/v1/agenda-item/for-link-targets
Lists the caller's agenda items linked to the given tasks, requests or other items.
agenda.agendaItem.getForLinkTargets
POST/api/v1/agenda-item/from-link
Creates an agenda item linked to a task, request or other item.
agenda.agendaItem.createFromLink
POST/api/v1/agenda-item/reorder-day
Puts the unscheduled agenda items of a day in the given order, moving any from other days.
agenda.agendaItem.reorderDay
GET/api/v1/agenda-item/team-member/{userId}
Lists a teammate's agenda for a date range, as far as the caller may see it.
agenda.agendaItem.getListForTeamMember
GET/api/v1/agenda-item/vacations
Lists the caller's vacation days in a date range, as the agenda shows them.
agenda.agendaItem.getVacationDays

Request bodies:

  • CreateAgendaItemDto (create): requires date (date (yyyy-MM-dd)), text (string).
  • UpdateAgendaItemDto (update): requires date (date (yyyy-MM-dd)), text (string).
  • CreateTaskFromAgendaItemDto (createTaskFromAgendaItem): requires title (string).
  • CreateAgendaItemFromLinkDto (createFromLink): requires date (date (yyyy-MM-dd)), kind (AgendaItemLinkKind: ProjectTask, Meeting, PullRequest, ProjectRequest, AgendaItemRequest, AppRecord, AppPublishRequest), targetId (uuid).

Agenda requests

POST/api/v1/agenda-item-request
Asks a teammate to put something on their agenda.
agenda.agendaItemRequest.create
GET/api/v1/agenda-item-request/{id}
Gets an agenda request the caller sent or received.
agenda.agendaItemRequest.get
POST/api/v1/agenda-item-request/{id}/accept
Accepts an agenda request, adding it to the caller's agenda.
agenda.agendaItemRequest.accept
POST/api/v1/agenda-item-request/{id}/accept-as-task
Accepts an agenda request as a task in a project.
agenda.agendaItemRequest.acceptAsTask
POST/api/v1/agenda-item-request/{id}/forward
Forwards an agenda request sent to the caller to another teammate.
agenda.agendaItemRequest.forward
POST/api/v1/agenda-item-request/{id}/ignore
Ignores an agenda request sent to the caller.
agenda.agendaItemRequest.ignore
GET/api/v1/agenda-item-request/pending
Lists the agenda requests waiting for the caller's answer.
agenda.agendaItemRequest.getPendingList
GET/api/v1/agenda-item-request/pending-count
Counts the agenda requests waiting for the caller's answer.
agenda.agendaItemRequest.getPendingCount
GET/api/v1/agenda-item-request/sent
Lists the agenda requests the caller sent, one page at a time.
agenda.agendaItemRequest.getSent

Request bodies:

  • CreateAgendaItemRequestDto (create): requires recipientUserId (uuid), text (string).

Recurring agenda items

GET/api/v1/recurring-agenda-item/{id}
Gets one of the caller's recurring agenda items.
agenda.recurringAgendaItem.get
PUT/api/v1/recurring-agenda-item/{id}
Changes a recurring agenda item and its schedule.
agenda.recurringAgendaItem.update
DELETE/api/v1/recurring-agenda-item/{id}
Deletes a recurring agenda item with all its occurrences.
agenda.recurringAgendaItem.delete
PUT/api/v1/recurring-agenda-item/{id}/occurrence
Changes one occurrence of a recurring agenda item without changing the others.
agenda.recurringAgendaItem.updateOccurrence
POST/api/v1/recurring-agenda-item/{id}/occurrence/cancel
Cancels one occurrence of a recurring agenda item.
agenda.recurringAgendaItem.cancelOccurrence
POST/api/v1/recurring-agenda-item/{id}/occurrence/restore
Restores a cancelled occurrence of a recurring agenda item.
agenda.recurringAgendaItem.restoreOccurrence

Request bodies:

  • UpdateRecurringAgendaItemDto (update): requires recurrence (AgendaRecurrenceInputDto), text (string).
  • UpdateAgendaOccurrenceDto (updateOccurrence): requires occurrenceStartUtc (date-time), text (string).

Example

agenda.agendaItem.getList: lists the caller's agenda items for a date range.

curl
curl -s "https://volobox.example.com/api/v1/agenda-item" \
  -H "Authorization: Bearer $VOLOBOX_TOKEN"