HTTP API

Reference

People API

Endpoints for the team directory, member profiles, people lookup, expertise tags and the caller's own profile and status.

This group covers the workspace's people: the team directory, member profiles, the people lookup and expertise tags, and the caller's own profile, status, Do Not Disturb, language and time zone. 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.

Members and profiles

PUT/api/v1/app-user/{id}/profile
Corrects the structured profile fields of a workspace member, for people managers.
people.appUser.updateTeamMemberProfile
GET/api/v1/app-user/{id}/team-member-profile
Gets a workspace member's profile by id.
people.appUser.getTeamMemberProfile
GET/api/v1/app-user/by-username/{userName}/team-member-profile
Gets a workspace member's profile by user name.
people.appUser.getTeamMemberProfileByUserName
PUT/api/v1/app-user/my-dnd
Turns the caller's Do Not Disturb on until a given time, or off. Acts on the signed-in person's own account.
people.appUser.setMyDoNotDisturb
PUT/api/v1/app-user/my-dnd/outside-working-hours
Turns the caller's Do Not Disturb on or off automatically outside their working hours. Acts on the signed-in person's own account.
people.appUser.setMyDoNotDisturbOutsideWorkingHours
GET/api/v1/app-user/my-profile
Gets the caller's own profile. Acts on the signed-in person's own account.
people.appUser.getMyProfile
PUT/api/v1/app-user/my-profile
Changes the caller's own profile. Acts on the signed-in person's own account.
people.appUser.updateMyProfile
PUT/api/v1/app-user/my-status
Sets the caller's own status, until a given time or until cleared, with an optional note. Acts on the signed-in person's own account.
people.appUser.setMyStatus
DELETE/api/v1/app-user/my-status
Clears the caller's own status. Acts on the signed-in person's own account.
people.appUser.clearMyStatus
GET/api/v1/app-user/team-directory
Lists the workspace's active members with their presence, vacation and working-hours state.
people.appUser.getTeamDirectory

Request bodies:

  • UpdateTeamMemberProfileDto (updateTeamMemberProfile): no field is required.
  • UpdateMyProfileDto (updateMyProfile): no field is required.

Expertise tags

GET/api/v1/expertise-tags
Lists every expertise term with how many people claim it, for people managers.
people.expertiseTags.getAdminList
PUT/api/v1/expertise-tags/{id}
Renames an expertise term, for people managers.
people.expertiseTags.rename
DELETE/api/v1/expertise-tags/{id}
Deletes an expertise term and every claim of it, for people managers.
people.expertiseTags.delete
POST/api/v1/expertise-tags/merge
Folds expertise terms into another one and deletes them, for people managers.
people.expertiseTags.merge
GET/api/v1/expertise-tags/search
Searches the expertise terms people have claimed, by name.
people.expertiseTags.search

People lookup

GET/api/v1/people/lookup/{id}
Looks up one active workspace member by id.
people.lookup.get
GET/api/v1/people/lookup/by-username/{userName}
Looks up one active workspace member by user name.
people.lookup.getByUserName
GET/api/v1/people/lookup/search
Searches the active workspace members by user name, name, surname or email, at most 50 at a time.
people.lookup.search

Language and time zone

GET/api/v1/me/language
Gets the caller's language. Acts on the signed-in person's own account.
people.me.getLanguage
PUT/api/v1/me/language
Changes the caller's language. Acts on the signed-in person's own account.
people.me.updateLanguage
PUT/api/v1/me/time-zone
Changes the caller's time zone. Acts on the signed-in person's own account.
people.me.updateTimeZone

Request bodies:

  • UpdateLanguageDto (updateLanguage): no field is required.
  • UpdateTimeZoneDto (updateTimeZone): requires source (string), timeZoneId (string).

Example

people.appUser.getMyProfile: gets the caller's own profile.

curl
curl -s "https://volobox.example.com/api/v1/app-user/my-profile" \
  -H "Authorization: Bearer $VOLOBOX_TOKEN"