Improved

Time Off API: policyTypeCustomName on get request details

We added policyTypeCustomName to the response for the Get the details of an existing time off request endpoint.

What changed

Time off request responses now include a dedicated field for the policy’s configured custom label:

  • policyTypeCustomName — the custom label configured on the policy, when one exists.

This field is returned together with the existing policyTypeDisplayName and visibility fields, so integrations can understand which policy name is safe to show and when the original policy type name may be exposed.

How visibility affects policy type names

The policy type's visibility field explains how the policy type name should be treated:

  • Public: the policy type name is not sensitive. Use policyTypeDisplayName; policyTypeCustomName is null.
  • Custom name: the policy has a public-facing custom label. Use policyTypeCustomName when you need the non-sensitive label. policyTypeDisplayName may contain the original policy type name if the caller has permission to see it.
  • Private: the policy type name is sensitive. The request is returned only when the caller has permission, and policyTypeDisplayName contains the original policy type name. policyTypeCustomName is null.

Affected endpoint

Notes

  • This is an additive and backward-compatible change.
  • Existing integrations can continue using policyTypeDisplayName as before.
  • For the full behavior by visibility and permission, see Policy type names in API responses.