Skip to content
shuffl
Get started

Searches the public product guides only. Nothing from a workspace is read, and questions are not saved.

Reference

Who’s out and free time API

5 operations. Generated from the OpenAPI document, so this page always matches the API.

OpenAPI documentErrors and rate limitsSDK and CLI recipes

On this page

availability.freeTime

Read when a coworker is free in their working hours, from their shared calendar

POST/api/v1/manage/availability/freeTime

const result = await shuffl.availability.freeTime({
  "personId": "<personId>"
});
Request fields (2)
  • days number optional
  • personId string required
Response object

The response is object.

availability.settings

Read whether Who’s out is on for the workspace

POST/api/v1/manage/availability/settings

const result = await shuffl.availability.settings();
Request fields (none)

This operation takes no input.

Response object
  • enabled boolean required
  • refreshedAt null | string required

availability.whosOut

Read who is out in the coming days, from shared calendars and the HR system

POST/api/v1/manage/availability/whosOut

const result = await shuffl.availability.whosOut({});
Request fields (2)
  • days number optional
  • from string optional
Response object
  • asOf null | string required
  • coverage object required
    • hrSystem null | string required
    • sharingCalendars number required
  • enabled boolean required
  • from string required
  • people object[] required
    • endsOn string required
    • jobTitle null | string required
    • name string required
    • personId string required
    • photoUrl null | string required
    • sources "calendar" | "hr_system"[] required
    • startsOn string required
  • to string required

availability.saveSettings

Turn Who’s out on or off for the workspace

POST/api/v1/manage/availability/saveSettings

const result = await shuffl.availability.saveSettings({
  "enabled": false,
  "confirm": "availability.saveSettings",
  "requestKey": "a-new-unique-key"
});
Request fields (3)
  • enabled boolean required
  • confirm "availability.saveSettings" required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • enabled boolean required

availability.share

Choose whether coworkers see when you’re out and free

POST/api/v1/manage/availability/share

  • Write
  • Permission availability.share
  • Needs a requestKey
  • Needs confirm set to availability.share
const result = await shuffl.availability.share({
  "share": false,
  "confirm": "availability.share",
  "requestKey": "a-new-unique-key"
});
Request fields (3)
  • share boolean required
  • confirm "availability.share" required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • changed boolean required
    • share boolean required