Sign in
Time Off

Get worker remaining time-off balances.

get/v1/time_off/balances

Query parameters

limitstring

a number less than or equal to 100

a number less than or equal to 100

afterIdstring
beforeIdstring
policyIdsstring[] 
[
  "top_1234"
]
workerIdsstring[] 
[
  "wrk_1234"
]
startDatestring

a string to be decoded into a Date

endDatestring

a string to be decoded into a Date

Response

Success

hasMoreboolean required
countinteger required

an integer

Example response

{
  "data": [
    {
      "policyId": "top_1234"
    }
  ]
}

Changes

Changed in 12 of the 20 revisions of this API.9116

  • a896c17cf98841See the full diff
    • ▲

      the response's body type/format changed from object/ to / for status 403

      response-body-type-changed

    • ▲

      removed the required property _tag from the response with the 403 status

      response-required-property-removed

    • ▲

      removed the required property message from the response with the 403 status

      response-required-property-removed

    • ▲

      removed the required property requiredPermissions from the response with the 403 status

      response-required-property-removed

    • ○

      added MissingRequiredPermissions ApiNotEnabled to the response body anyOf list for the response status 403

      response-body-any-of-added

  • 6cfbdf910b801See the full diff
    • ●

      added the new company:workplaces enum value to the requiredPermissions/items/scope response property for the response status 403

      response-property-enum-value-added

  • 768d9cb8d8d923See the full diff
    • ▲

      the requiredPermissions/items/ response property's minItems was decreased from 2 to 0 for the response status 403

      response-property-min-items-decreased

    • ▲

      the requiredPermissions/items/ response's property type/format changed from array/ to object/ for status 403

      response-property-type-changed

    • ○

      removed subschema #1 subschema #2 from the requiredPermissions/items/ response property 'prefixItems' list for the response status 403

      response-property-prefix-items-removed

    • ○

      added the required property requiredPermissions/items/level to the response with the 403 status

      response-required-property-added

    • ○

      added the required property requiredPermissions/items/scope to the response with the 403 status

      response-required-property-added

  • 787281d7e9a21See the full diff
    • ○

      added the non-success response with the status 403

      response-non-success-status-added

  • d256b456551d1See the full diff
    • ○

      added the required property count to the response with the 200 status

      response-required-property-added

  • 19dde65e36793See the full diff
    • ○

      added subschema #1: startsWith("top_") to the id response property anyOf list for the response status 404

      response-property-any-of-added

    • ○

      removed subschema #1 from the id response property anyOf list for the response status 404

      response-property-any-of-removed

    • ○

      the data/items/policyId response's property pattern ^top_ was added for the status 200

      response-property-pattern-added

  • 51a25af9420b1See the full diff
    • ▲

      response property id list-of-types was widened by adding types number to media type application/json of response 404

      response-property-list-of-types-widened

  • 6296f9b186ea1See the full diff
    • ○

      added the required property data/items/id to the response with the 200 status

      response-required-property-added

  • fbc6e46bbea21See the full diff
    • ▲

      removed the required property data/items/id from the response with the 200 status

      response-required-property-removed

  • 6296f9b186ea1See the full diff
    • ○

      added the required property data/items/id to the response with the 200 status

      response-required-property-added