When I Work · Schema

AvailabilityEvent

Employee SchedulingWorkforce ManagementTime TrackingTime ClockShift ManagementAttendanceTeam MessagingHourly WorkersLabor ForecastingHuman ResourcesScheduling

Properties

Name Type Description
id integer
account_id integer
user_id integer
login_id string
type integer Type code. 1 for "unavailable", 2 for "preferred"
start_time string Start time of the event. Must be no more than 24 hours in the past
end_time string End time of the event. If "all_day" is sent and true, this field is optional
all_day boolean
notes string Maximum of 160 characters
recurrence string Recurrence rule. See https://tools.ietf.org/html/rfc5545
recurrence_end string End date of the recurring series. Null for "does not repeat" or "repeats infinitely"
created_at string
updated_at string
View JSON Schema on GitHub

JSON Schema

when-i-work-availability-event-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/when-i-work/json-schema/when-i-work-availability-event-schema.json",
  "title": "AvailabilityEvent",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/when-i-work-availabilities-api-openapi.yml#/components/schemas/AvailabilityEvent",
  "type": "object",
  "required": [
    "start_time",
    "type"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true
    },
    "account_id": {
      "type": "integer"
    },
    "user_id": {
      "type": "integer"
    },
    "login_id": {
      "type": "string"
    },
    "type": {
      "type": "integer",
      "enum": [
        1,
        2
      ],
      "description": "Type code. 1 for \"unavailable\", 2 for \"preferred\""
    },
    "start_time": {
      "type": "string",
      "format": "date-time",
      "description": "Start time of the event. Must be no more than 24 hours in the past"
    },
    "end_time": {
      "type": "string",
      "format": "date-time",
      "description": "End time of the event. If \"all_day\" is sent and true, this field is optional"
    },
    "all_day": {
      "type": "boolean"
    },
    "notes": {
      "type": "string",
      "description": "Maximum of 160 characters"
    },
    "recurrence": {
      "type": "string",
      "description": "Recurrence rule. See https://tools.ietf.org/html/rfc5545"
    },
    "recurrence_end": {
      "type": "string",
      "readOnly": true,
      "format": "date-time",
      "description": "End date of the recurring series. Null for \"does not repeat\" or \"repeats infinitely\""
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/when-i-work-availability-event"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.