Saved views

Private and team views of the CRM lists, and counts for their tabs.

GET/v1/saved-views

Saved views of a list

Your private views and the team’s, pinned first. Needs view access to the entity (leads.view …).

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

Parameters

entityqueryrequired: SavedViewEntity

Response · 200

datarequired: array of SavedView
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "entity": "string",
      "name": "string",
      "visibility": "private",
      "filters": null,
      "columns": [
        "string"
      ],
      "sort": "string",
      "layout": "table",
      "is_pinned": true,
      "author": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "mine": true,
      "editable": true,
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_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.
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/saved-views

Save a view

The filter is checked against the entity’s field registry (422 names the bad condition).

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

Request body

entityrequired: SavedViewEntity
namerequired: string
visibility: SavedViewVisibility
filters: FilterNode or null
PropZolo filter: { all: [...] } | { any: [...] } | { not: … } | { field, op, value }
columns: array of string or null
sort: string or null
layout: SavedViewLayout
is_pinned: boolean

Response · 201

datarequired: SavedView
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/saved-views' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"entity":"leads","name":"string","visibility":"private","filters":null,"columns":["string"],"sort":"string","layout":"table","is_pinned":true}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "entity": "string",
    "name": "string",
    "visibility": "private",
    "filters": null,
    "columns": [
      "string"
    ],
    "sort": "string",
    "layout": "table",
    "is_pinned": true,
    "author": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "mine": true,
    "editable": true,
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_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.
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/saved-views/counts

Counts for list tabs

Up to 25 list queries (smart lists, saved views, the current filter) counted within your scope; the answer maps each key to its count.

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

Request body

entityrequired: "leads"
queriesrequired: map of ViewCountQuery

Response · 200

datarequired: map of integer
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/saved-views/counts' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"entity":"leads","queries":{}}'

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.
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/saved-views/{id}

Change, rename or re-share a view

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

name: string
visibility: SavedViewVisibility
filters: FilterNode or null
PropZolo filter: { all: [...] } | { any: [...] } | { not: … } | { field, op, value }
columns: array of string or null
sort: string or null
layout: SavedViewLayout
is_pinned: boolean

Response · 200

datarequired: SavedView
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/saved-views/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","visibility":"private","filters":null,"columns":["string"],"sort":"string","layout":"table","is_pinned":true}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "entity": "string",
    "name": "string",
    "visibility": "private",
    "filters": null,
    "columns": [
      "string"
    ],
    "sort": "string",
    "layout": "table",
    "is_pinned": true,
    "author": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "mine": true,
    "editable": true,
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_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.
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.

DELETE/v1/saved-views/{id}

Delete a view

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

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

Request

curl -X DELETE 'https://api.propzolo.com/v1/saved-views/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "deleted": 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.
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", "entity": "string", "name": "string", "visibility": "private", "filters": null, "columns": [ "string" ], "sort": "string", "layout": "table", "is_pinned": true, "author": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "mine": true, "editable": true, "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z" } ], "meta": {} }

curl -X POST 'https://api.propzolo.com/v1/saved-views' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"entity":"leads","name":"string","visibility":"private","filters":null,"columns":["string"],"sort":"string","layout":"table","is_pinned":true}'

{ "data": { "id": "cmusrceel0000q7kaafxqi1om", "entity": "string", "name": "string", "visibility": "private", "filters": null, "columns": [ "string" ], "sort": "string", "layout": "table", "is_pinned": true, "author": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "mine": true, "editable": true, "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z" }, "meta": {} }

POST/v1/saved-views/counts

Counts for list tabs

Up to 25 list queries (smart lists, saved views, the current filter) counted within your scope; the answer maps each key to its count.

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

Request body

entityrequired: "leads"
queriesrequired: map of ViewCountQuery

Response · 200

datarequired: map of integer
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/saved-views/counts' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"entity":"leads","queries":{}}'

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.
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.

curl -X PATCH 'https://api.propzolo.com/v1/saved-views/{id}' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"name":"string","visibility":"private","filters":null,"columns":["string"],"sort":"string","layout":"table","is_pinned":true}'