Calendar sync

Members’ own Google / Microsoft 365 calendars: PropZolo’s calendar with visits and meetings, free/busy blocks for the visit scheduler (times only), and disconnect.

GET/v1/calendar

My calendar sync

Your connection (or none), the providers PropZolo offers and the text you agree to before connecting.

Access: Signed-in members only (web or Android session) — not for API keys.

Response · 200

datarequired: CalendarOverview
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/calendar' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "connection": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "provider": "google",
      "email": "string",
      "status": "active",
      "status_reason": "string",
      "settings": {
        "visits": true,
        "meetings": true,
        "follow_ups": true
      },
      "busy_enabled": true,
      "calendar_ready": true,
      "connected_at": "2026-10-06T05:30:00.000Z",
      "last_sync_at": "2026-10-06T05:30:00.000Z",
      "last_ok_at": "2026-10-06T05:30:00.000Z",
      "next_sync_at": "2026-10-06T05:30:00.000Z",
      "busy_synced_at": "2026-10-06T05:30:00.000Z",
      "last_error": "string",
      "events": 0,
      "cleanup_pending": true
    },
    "providers": [
      {
        "provider": "google",
        "label": "string",
        "available": true
      }
    ],
    "consent": {
      "version": "string",
      "points": [
        "string"
      ]
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/calendar

What goes into my calendar

Access: Signed-in members only (web or Android session) — not for API keys.

Request body

visits: boolean
Site visits where you are the agent.
meetings: boolean
Meetings and other tasks with a time.
follow_ups: boolean
Follow-ups and call tasks.

Response · 200

datarequired: CalendarConnection
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/calendar' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"visits":true,"meetings":true,"follow_ups":true}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "provider": "google",
    "email": "string",
    "status": "active",
    "status_reason": "string",
    "settings": {
      "visits": true,
      "meetings": true,
      "follow_ups": true
    },
    "busy_enabled": true,
    "calendar_ready": true,
    "connected_at": "2026-10-06T05:30:00.000Z",
    "last_sync_at": "2026-10-06T05:30:00.000Z",
    "last_ok_at": "2026-10-06T05:30:00.000Z",
    "next_sync_at": "2026-10-06T05:30:00.000Z",
    "busy_synced_at": "2026-10-06T05:30:00.000Z",
    "last_error": "string",
    "events": 0,
    "cleanup_pending": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

DELETE/v1/calendar

Disconnect my calendar

Stops at once; PropZolo’s calendar is then deleted from your account and your busy times forgotten.

Access: Signed-in members only (web or Android session) — not for API keys.

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
metarequired: object

Request

curl -X DELETE 'https://api.propzolo.com/v1/calendar' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/calendar/busy

A member’s busy times

For yourself, or for a member you may book visits for (`site_visits.create`): start and end of each busy block from their connected calendar, at most 31 days.

Access: Signed-in members only (web or Android session) — not for API keys. Permission site_visits.view.

Parameters

member_idqueryrequired: Id
Opaque record id.
fromqueryrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
toqueryrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.

Response · 200

datarequired: MemberBusy
Busy blocks of a member’s own calendar: times only.
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/calendar/busy' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "connected": true,
    "synced_at": "2026-10-06T05:30:00.000Z",
    "blocks": [
      {
        "start": "2026-10-06T05:30:00.000Z",
        "end": "2026-10-06T05:30:00.000Z"
      }
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/calendar/sync

Sync my calendar now

Access: Signed-in members only (web or Android session) — not for API keys.

Response · 202

datarequired: CalendarConnection
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/calendar/sync' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "provider": "google",
    "email": "string",
    "status": "active",
    "status_reason": "string",
    "settings": {
      "visits": true,
      "meetings": true,
      "follow_ups": true
    },
    "busy_enabled": true,
    "calendar_ready": true,
    "connected_at": "2026-10-06T05:30:00.000Z",
    "last_sync_at": "2026-10-06T05:30:00.000Z",
    "last_ok_at": "2026-10-06T05:30:00.000Z",
    "next_sync_at": "2026-10-06T05:30:00.000Z",
    "busy_synced_at": "2026-10-06T05:30:00.000Z",
    "last_error": "string",
    "events": 0,
    "cleanup_pending": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/calendar/{provider}/oauth/callback

Calendar sign-in callback

Always redirects back to Settings → My account → Calendar with `connected=<provider>` or `error=…`.

Access: Signed-in members only (web or Android session) — not for API keys.

Parameters

providerpathrequired: "google" | "microsoft"
codequery: string
statequery: string
errorquery: string
error_descriptionquery: string
scopequery: string
session_statequery: string

Response · 200

datarequired: object
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/calendar/{provider}/oauth/callback' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {},
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/calendar/{provider}/oauth/start

Connect my calendar: the provider’s sign-in

Needs the consent text version you agreed to (`consent`). Returns the provider’s consent URL (or redirects with `?redirect=1`). 404 until PropZolo set the provider up.

Access: Signed-in members only (web or Android session) — not for API keys.

Parameters

providerpathrequired: "google" | "microsoft"
consentqueryrequired: string
redirectquery: "1"

Response · 200

datarequired: object
data.urlrequired: string
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/calendar/{provider}/oauth/start' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "url": "string"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

{ "data": { "connection": { "id": "cmusrceel0000q7kaafxqi1om", "provider": "google", "email": "string", "status": "active", "status_reason": "string", "settings": { "visits": true, "meetings": true, "follow_ups": true }, "busy_enabled": true, "calendar_ready": true, "connected_at": "2026-10-06T05:30:00.000Z", "last_sync_at": "2026-10-06T05:30:00.000Z", "last_ok_at": "2026-10-06T05:30:00.000Z", "next_sync_at": "2026-10-06T05:30:00.000Z", "busy_synced_at": "2026-10-06T05:30:00.000Z", "last_error": "string", "events": 0, "cleanup_pending": true }, "providers": [ { "provider": "google", "label": "string", "available": true } ], "consent": { "version": "string", "points": [ "string" ] } }, "meta": {} }

{ "data": { "id": "cmusrceel0000q7kaafxqi1om", "provider": "google", "email": "string", "status": "active", "status_reason": "string", "settings": { "visits": true, "meetings": true, "follow_ups": true }, "busy_enabled": true, "calendar_ready": true, "connected_at": "2026-10-06T05:30:00.000Z", "last_sync_at": "2026-10-06T05:30:00.000Z", "last_ok_at": "2026-10-06T05:30:00.000Z", "next_sync_at": "2026-10-06T05:30:00.000Z", "busy_synced_at": "2026-10-06T05:30:00.000Z", "last_error": "string", "events": 0, "cleanup_pending": true }, "meta": {} }

{ "data": { "connected": true, "synced_at": "2026-10-06T05:30:00.000Z", "blocks": [ { "start": "2026-10-06T05:30:00.000Z", "end": "2026-10-06T05:30:00.000Z" } ] }, "meta": {} }

GET/v1/calendar/{provider}/oauth/callback

Calendar sign-in callback

Always redirects back to Settings → My account → Calendar with `connected=<provider>` or `error=…`.

Access: Signed-in members only (web or Android session) — not for API keys.

Parameters

providerpathrequired: "google" | "microsoft"
codequery: string
statequery: string
errorquery: string
error_descriptionquery: string
scopequery: string
session_statequery: string

Response · 200

datarequired: object
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/calendar/{provider}/oauth/callback' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {},
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.