Skip to main content

Use the Who’s Out API for Capacity Planning With Generic Time Off Labels

  • Nov 19, 2026 9:39 AM UTC
  • 0 replies
  • 1 view
  • Translate All

Itamar Sahar
Bobber

Help your capacity planning integration use absence dates while controlling which policy names it can see.

If your application needs employee absence dates, evaluate GET /v1/timeoff/whosout. It accepts a date range and limits results to employees within the service user’s access scope. Generic policy labels can help conceal the reason for an absence, but they do not establish field-level access controls or guarantee a dates-only response.

  1. Use a dedicated service user and restrict its employee access scope to the people required by the integration.
  2. Grant See who’s out under People’s Data > Time off > See who’s out today. Leave the additional permission for viewing private policies and original names disabled unless the integration requires that access.
  3. Configure a generic public custom name, such as Out of office, for the relevant policies.
  4. Call the endpoint with the required from and to dates and explicitly set includePrivate=false.
  5. Review the complete response using that service user before connecting the planning application.

 

| Setting | Private Requests | `policyTypeDisplayName` |

| --- | --- | --- |

| `false` | Excluded | Configured custom label for policies with a public custom name |

| `true`, with the required permission | Included | Original policy type name, even when a custom label exists |

 

For example, with a custom label of Out of office, includePrivate=false returns that label in policyTypeDisplayName. Enabling includePrivate=true with the required permission returns the original name instead.

Excluding private requests can leave gaps in capacity planning. Confirm whether those absences need to be included before choosing this configuration.

A custom label controls the displayed policy name. Do not assume it also removes personal notes, reasons, identifiers, or every other sensitive field. The integration owner should inspect the full response and approve the fields the planning application receives. If filtering is needed, an intermediary could forward only approved fields, such as employee ID and absence dates. The intermediary would still receive the original response.

For an individual date, evaluate the Out Today API, which documents the same private-request and naming behavior.

See the Who’s Out API reference and Time Off API permissions for configuration details. For questions about a specific response or a request for more granular permissions, contact the Customer Experience Team.