list_absences

This reference is generated from the published tool contract.

Behavior and boundaries

Lists absences (vacation, sick leave, training, other) of workspace members that overlap a period, at most 92 days, default the next 92 days. During an absence the member gets no booking slots and round robin skips them. The reason is only included for your own absences or if you are an owner or admin; otherwise it is null. Also returns the members with their user_id, for choosing a substitute.

Permissions

Granted scopes, accounts, calendars and visibility rules limit access. Workspace administrators do not automatically gain access to other users’ accounts.

bookings:read

Consent and boundaries

Input

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "from": {
      "description": "Start of the period, ISO date-time with offset. Default: now.",
      "type": "string",
      "maxLength": 40
    },
    "to": {
      "description": "End of the period (exclusive). Default and maximum: from + 92 days.",
      "type": "string",
      "maxLength": 40
    },
    "user_id": {
      "description": "Only this member's absences.",
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    }
  },
  "additionalProperties": false
}

Output

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "absences": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "absence_id": {
            "type": "string"
          },
          "user_id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "start": {
            "type": "string"
          },
          "end": {
            "type": "string"
          },
          "all_day": {
            "type": "boolean"
          },
          "first_day": {
            "type": [
              "string",
              "null"
            ]
          },
          "last_day": {
            "type": [
              "string",
              "null"
            ]
          },
          "time_zone": {
            "type": "string"
          },
          "reason": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "vacation",
                  "sick",
                  "training",
                  "other"
                ]
              },
              {
                "type": "null"
              }
            ]
          },
          "substitute": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "user_id": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  }
                },
                "required": [
                  "user_id",
                  "name"
                ],
                "additionalProperties": false
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "absence_id",
          "user_id",
          "name",
          "start",
          "end",
          "all_day",
          "first_day",
          "last_day",
          "time_zone",
          "reason",
          "substitute"
        ],
        "additionalProperties": false
      }
    },
    "members": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "user_id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "user_id",
          "name"
        ],
        "additionalProperties": false
      }
    },
    "console_url": {
      "type": "string"
    }
  },
  "required": [
    "absences",
    "members",
    "console_url"
  ],
  "additionalProperties": false
}

Errors and retries

Check the tool result for errors. Do not blindly retry writes after a timeout. Check the current resource or send status first.

Error handling