Timeline

The timeline of a lead or a contact: notes with @mentions, status changes, calls, visits and system events.

GET/v1/activities

Timeline of a lead or a contact

Name `lead_id` or `contact_id`. A contact’s timeline includes the entries of its leads you can see.

Access: API key with leads:read, or a member session. Permission leads.view.

Parameters

lead_idquery: Id
Opaque record id.
contact_idquery: Id
Opaque record id.
typesquery: string
Comma list of activity types, e.g. note,status_change.
cursorquery: string
limitquery: integer

Response · 200

datarequired: array of Activity
metarequired: object
meta.next_cursorrequired: string or null
Opaque cursor of the next page; null on the last page.
meta.has_morerequired: boolean
meta.pinned: array of Activity

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "type": "string",
      "title": "string",
      "body": "string",
      "meta": null,
      "is_pinned": true,
      "occurred_at": "2026-10-06T05:30:00.000Z",
      "created_at": "2026-10-06T05:30:00.000Z",
      "actor": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "lead_id": "cmusrceel0000q7kaafxqi1om",
      "contact_id": "cmusrceel0000q7kaafxqi1om",
      "edited_at": "2026-10-06T05:30:00.000Z",
      "can_edit": true
    }
  ],
  "meta": {
    "next_cursor": "string",
    "has_more": true,
    "pinned": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "type": "string",
        "title": "string",
        "body": "string",
        "meta": null,
        "is_pinned": true,
        "occurred_at": "2026-10-06T05:30:00.000Z",
        "created_at": "2026-10-06T05:30:00.000Z",
        "actor": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "lead_id": "cmusrceel0000q7kaafxqi1om",
        "contact_id": "cmusrceel0000q7kaafxqi1om",
        "edited_at": "2026-10-06T05:30:00.000Z",
        "can_edit": 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/activities

Add a note

On a lead or a contact; `mention_ids` are notified (never the author).

Access: API key with leads:write, or a member session. Permission leads.edit.

Parameters

Idempotency-Keyheader: string
Unique key (a UUID) per logical request. A retry with the same key and body replays the first response for 24 hours (marked Idempotent-Replayed: true); the same key with another body is a 409.

Request body

lead_id: Id or null
Opaque record id.
contact_id: Id or null
Opaque record id.
bodyrequired: string
mention_ids: array of Id
Opaque record id.
pinned: boolean

Response · 201

datarequired: Activity
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/activities' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"lead_id":"cmusrceel0000q7kaafxqi1om","contact_id":"cmusrceel0000q7kaafxqi1om","body":"string","mention_ids":["cmusrceel0000q7kaafxqi1om"],"pinned":true}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "type": "string",
    "title": "string",
    "body": "string",
    "meta": null,
    "is_pinned": true,
    "occurred_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "actor": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "lead_id": "cmusrceel0000q7kaafxqi1om",
    "contact_id": "cmusrceel0000q7kaafxqi1om",
    "edited_at": "2026-10-06T05:30:00.000Z",
    "can_edit": 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.

PATCH/v1/activities/{id}

Edit a note / pin an entry

Notes can be corrected by their author for 15 minutes (409 later); any entry can be pinned or unpinned.

Access: API key with leads:write, or a member session. Permission leads.edit.

Parameters

idpathrequired: Id
Opaque record id.

Request body

body: string
is_pinned: boolean

Response · 200

datarequired: Activity
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/activities/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"body":"string","is_pinned":true}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "type": "string",
    "title": "string",
    "body": "string",
    "meta": null,
    "is_pinned": true,
    "occurred_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "actor": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "lead_id": "cmusrceel0000q7kaafxqi1om",
    "contact_id": "cmusrceel0000q7kaafxqi1om",
    "edited_at": "2026-10-06T05:30:00.000Z",
    "can_edit": 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.
404 Not found — records of another company are reported the same way.
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", "type": "string", "title": "string", "body": "string", "meta": null, "is_pinned": true, "occurred_at": "2026-10-06T05:30:00.000Z", "created_at": "2026-10-06T05:30:00.000Z", "actor": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "lead_id": "cmusrceel0000q7kaafxqi1om", "contact_id": "cmusrceel0000q7kaafxqi1om", "edited_at": "2026-10-06T05:30:00.000Z", "can_edit": true } ], "meta": { "next_cursor": "string", "has_more": true, "pinned": [ { "id": "cmusrceel0000q7kaafxqi1om", "type": "string", "title": "string", "body": "string", "meta": null, "is_pinned": true, "occurred_at": "2026-10-06T05:30:00.000Z", "created_at": "2026-10-06T05:30:00.000Z", "actor": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "lead_id": "cmusrceel0000q7kaafxqi1om", "contact_id": "cmusrceel0000q7kaafxqi1om", "edited_at": "2026-10-06T05:30:00.000Z", "can_edit": true } ] } }

curl -X POST 'https://api.propzolo.com/v1/activities' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Idempotency-Key: 6c0f1d3e-…' \ -H 'Content-Type: application/json' \ -d '{"lead_id":"cmusrceel0000q7kaafxqi1om","contact_id":"cmusrceel0000q7kaafxqi1om","body":"string","mention_ids":["cmusrceel0000q7kaafxqi1om"],"pinned":true}'

{ "data": { "id": "cmusrceel0000q7kaafxqi1om", "type": "string", "title": "string", "body": "string", "meta": null, "is_pinned": true, "occurred_at": "2026-10-06T05:30:00.000Z", "created_at": "2026-10-06T05:30:00.000Z", "actor": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "lead_id": "cmusrceel0000q7kaafxqi1om", "contact_id": "cmusrceel0000q7kaafxqi1om", "edited_at": "2026-10-06T05:30:00.000Z", "can_edit": true }, "meta": {} }