Email, calendar & files · Calendar

Busy blocks for one or more accounts

Busy blocks for one or more accounts.

POSThttps://api.pozy.ai/v1/calendar/free-busy
calendarFreeBusy

Guides: Calendar, Email, calendar & files, Google Workspace

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the calendar resource group disabled get 403 resource_group_disabled. Authentication

Request body

application/json, required

  • accountIdsarray of stringrequired

    At least 1 item. Up to 10 items.

  • fromstring (date-time)required
  • tostring (date-time)required

Example

curl -X POST "https://api.pozy.ai/v1/calendar/free-busy" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "accountIds": [
    "string"
  ],
  "from": "2026-10-02T09:00:00.000Z",
  "to": "2026-10-02T09:00:00.000Z"
}'

Response

200 on success

  • dataarray of object
    • accountIdstring
    • fromstring (date-time)
    • tostring (date-time)
    • busyarray of object
      2 child fields
      • startstring (date-time)
      • endstring (date-time)
200 response
{
  "data": [
    {
      "accountId": "696e0b682d0a31188e7a2ba9",
      "from": "2026-10-02T09:00:00.000Z",
      "to": "2026-10-02T09:00:00.000Z",
      "busy": [
        {
          "start": "2026-10-02T09:00:00.000Z",
          "end": "2026-10-02T09:00:00.000Z"
        }
      ]
    }
  ]
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Calendar