Apideck · Schema

TimeOffRequestsFilter

IntegrationsUnified API

Properties

Name Type Description
start_date string Start date of the date range to filter time off requests. When used with end_date, filters for requests within the specified date range.
end_date string End date of the date range to filter time off requests. When used with start_date, filters for requests within the specified date range.
updated_since string Minimum date the time off request was last created or modified
employee_id string Employee ID
time_off_request_status string Time off request status to filter on
company_id string Company ID
View JSON Schema on GitHub

JSON Schema

apideck-timeoffrequestsfilter-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TimeOffRequestsFilter",
  "title": "TimeOffRequestsFilter",
  "type": "object",
  "example": {
    "start_date": "2022-04-08",
    "end_date": "2022-04-21",
    "updated_since": "2020-09-30T07:43:32.000Z",
    "employee_id": "1234",
    "time_off_request_status": "approved",
    "company_id": "1234"
  },
  "properties": {
    "start_date": {
      "type": "string",
      "description": "Start date of the date range to filter time off requests. When used with end_date, filters for requests within the specified date range.",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "example": "2022-04-08"
    },
    "end_date": {
      "type": "string",
      "description": "End date of the date range to filter time off requests. When used with start_date, filters for requests within the specified date range.",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "example": "2022-04-21"
    },
    "updated_since": {
      "type": "string",
      "description": "Minimum date the time off request was last created or modified",
      "example": "2020-09-30T07:43:32.000Z"
    },
    "employee_id": {
      "type": "string",
      "description": "Employee ID",
      "example": "1234"
    },
    "time_off_request_status": {
      "type": "string",
      "description": "Time off request status to filter on",
      "example": "requested",
      "enum": [
        "requested",
        "approved",
        "declined",
        "cancelled",
        "deleted",
        "other"
      ]
    },
    "company_id": {
      "type": "string",
      "description": "Company ID",
      "example": "1234"
    }
  },
  "additionalProperties": false
}