Notifications

Badge counters, the member’s notifications and notification preferences.

GET/v1/announcements

Live PropZolo announcements

Banners from PropZolo (planned maintenance, product news) live right now for this workspace — every tenant, this company or its plan — newest first. Dismissing one is remembered on the device.

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

Response · 200

datarequired: array of Announcement
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "title": "string",
      "body": "string",
      "level": "info",
      "starts_at": "2026-10-06T05:30:00.000Z",
      "ends_at": "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.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/me/counters

Badge counters

Nav badges and the bell. Load on start, after every realtime (re)connect and on each poll while the stream is down; between loads, `counter.updated` events on /api/sse carry new values.

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

Response · 200

datarequired: MemberCounters
metarequired: object

Request

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

Response example

{
  "data": {
    "notifications.unread": 0,
    "inbox.unread": 0,
    "tasks.overdue": 0,
    "followups.pending": 0
  },
  "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/me/notification-preferences

My notification preferences

The member’s choices, the company’s switches (read-only) and what applies as a result.

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

Response · 200

datarequired: NotificationPreferencesView
metarequired: object

Request

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

Response example

{
  "data": {
    "member": {
      "push": true,
      "muted_events": [
        "string"
      ],
      "quiet_hours": {
        "start": "string",
        "end": "string"
      }
    },
    "company": {
      "rules": {},
      "quiet_hours": {
        "start": "string",
        "end": "string"
      }
    },
    "effective": {
      "push": true,
      "quiet_hours": {
        "start": "string",
        "end": "string"
      },
      "quiet_hours_source": "member"
    }
  },
  "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.

PUT/v1/me/notification-preferences

Replace my notification preferences

Replaces the member’s choices; an omitted key goes back to the company setting and the defaults.

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

Request body

push: boolean
false: no push notifications at all.
muted_events: array of string
Events delivered in-app only (no push).
quiet_hours: object or null
Push quiet hours in the company time zone; null: none; omitted: the company’s.
quiet_hours.startrequired: string
quiet_hours.endrequired: string

Response · 200

datarequired: NotificationPreferencesView
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/me/notification-preferences' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"push":true,"muted_events":["string"],"quiet_hours":{"start":"string","end":"string"}}'

Response example

{
  "data": {
    "member": {
      "push": true,
      "muted_events": [
        "string"
      ],
      "quiet_hours": {
        "start": "string",
        "end": "string"
      }
    },
    "company": {
      "rules": {},
      "quiet_hours": {
        "start": "string",
        "end": "string"
      }
    },
    "effective": {
      "push": true,
      "quiet_hours": {
        "start": "string",
        "end": "string"
      },
      "quiet_hours_source": "member"
    }
  },
  "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.

GET/v1/notifications

The member’s notifications

Newest first, keyset-paginated. `unread=1` lists unread ones only.

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

Parameters

cursorquery: string
Opaque cursor from the previous page (`meta.next_cursor`).
limitquery: integer
Page size, 1–100.
unreadquery: string
Only unread notifications.

Response · 200

datarequired: array of Notification
metarequired: PageMeta

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "event": "string",
      "title": "string",
      "body": "string",
      "link": "string",
      "entity_type": "string",
      "entity_id": "string",
      "is_read": true,
      "read_at": "2026-10-06T05:30:00.000Z",
      "created_at": "2026-10-06T05:30:00.000Z"
    }
  ],
  "meta": {
    "next_cursor": "string",
    "has_more": true
  }
}

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/notifications/read-all

Mark all notifications read

Send `before` (the created_at of the newest notification shown) so one arriving while the member clicks stays unread.

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

Request body (optional)

before: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.

Response · 200

datarequired: object
data.updatedrequired: integer
metarequired: object
meta.countersrequired: object
meta.counters.notifications.unreadrequired: integer

Request

curl -X POST 'https://api.propzolo.com/v1/notifications/read-all' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"before":"2026-10-06T05:30:00.000Z"}'

Response example

{
  "data": {
    "updated": 0
  },
  "meta": {
    "counters": {
      "notifications.unread": 0
    }
  }
}

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.

POST/v1/notifications/{id}/read

Mark a notification read

Idempotent. Another member’s notification is reported as not found.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: Notification
metarequired: object
meta.countersrequired: object
meta.counters.notifications.unreadrequired: integer

Request

curl -X POST 'https://api.propzolo.com/v1/notifications/{id}/read' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "event": "string",
    "title": "string",
    "body": "string",
    "link": "string",
    "entity_type": "string",
    "entity_id": "string",
    "is_read": true,
    "read_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {
    "counters": {
      "notifications.unread": 0
    }
  }
}

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": [ { "id": "cmusrceel0000q7kaafxqi1om", "title": "string", "body": "string", "level": "info", "starts_at": "2026-10-06T05:30:00.000Z", "ends_at": "2026-10-06T05:30:00.000Z" } ], "meta": {} }

{ "data": { "member": { "push": true, "muted_events": [ "string" ], "quiet_hours": { "start": "string", "end": "string" } }, "company": { "rules": {}, "quiet_hours": { "start": "string", "end": "string" } }, "effective": { "push": true, "quiet_hours": { "start": "string", "end": "string" }, "quiet_hours_source": "member" } }, "meta": {} }

curl -X PUT 'https://api.propzolo.com/v1/me/notification-preferences' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"push":true,"muted_events":["string"],"quiet_hours":{"start":"string","end":"string"}}'

{ "data": [ { "id": "cmusrceel0000q7kaafxqi1om", "event": "string", "title": "string", "body": "string", "link": "string", "entity_type": "string", "entity_id": "string", "is_read": true, "read_at": "2026-10-06T05:30:00.000Z", "created_at": "2026-10-06T05:30:00.000Z" } ], "meta": { "next_cursor": "string", "has_more": true } }

POST/v1/notifications/read-all

Mark all notifications read

Send `before` (the created_at of the newest notification shown) so one arriving while the member clicks stays unread.

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

Request body (optional)

before: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.

Response · 200

datarequired: object
data.updatedrequired: integer
metarequired: object
meta.countersrequired: object
meta.counters.notifications.unreadrequired: integer

Request

curl -X POST 'https://api.propzolo.com/v1/notifications/read-all' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"before":"2026-10-06T05:30:00.000Z"}'

Response example

{
  "data": {
    "updated": 0
  },
  "meta": {
    "counters": {
      "notifications.unread": 0
    }
  }
}

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.

{ "data": { "id": "cmusrceel0000q7kaafxqi1om", "event": "string", "title": "string", "body": "string", "link": "string", "entity_type": "string", "entity_id": "string", "is_read": true, "read_at": "2026-10-06T05:30:00.000Z", "created_at": "2026-10-06T05:30:00.000Z" }, "meta": { "counters": { "notifications.unread": 0 } } }