Skip to main content

LeadNoteFilterDTO

Request body for POST /v1/open-api/lead-note/filter. All fields optional except pagination; an omitted or empty-array filter matches everything. Leads notes have no custom fields — there is no customFields/fields key here.

pageint32

Page number, 1-based (min 1).

Possible values: >= 1

Default value: 1
Example: 1
sizeint32

Page size (min 1, max 100).

Possible values: >= 1 and <= 100

Default value: 15
Example: 15
orders object

Sort order. Each key is a sort field (see LeadNoteOrderField) and each value a direction. Keys are applied in the order they appear in the JSON object. Unless ID is one of the keys, a trailing ID DESC tie-breaker is appended. Omit (or send {}) to sort by ID DESC only.

property name*string

Possible values: [ASC, DESC]

searchstringnullable

Case-insensitive partial match on the note text (optional).

Example: callback
idsint64[]

Filter by exact note IDs — for bulk re-sync (optional).

Example: [7001,7002]
leadIdsint64[]

Filter by lead IDs — omit (or empty) for company-wide notes.

Example: [1001]
createdByIdsint32[]

Filter by the employee who wrote the note.

Example: [95]
deletedByIdsint32[]

Filter by the employee who deleted the note. Only meaningful with includeDeleted/deletedOnly.

Example: [95]
typesLeadNoteType[]

Filter by note type. Omit (or empty) for every type.

Possible values: [SIMPLE, SMS, PHONE]

pinnedbooleannullable

true — only pinned notes, false — only unpinned, null (omit) — don't filter.

Example: true
hasFilesbooleannullable

true — only notes with attached files, false — only notes without, null (omit) — don't filter.

Example: true
createdTimestampFromint64

Lower bound (inclusive) for createdTimestamp, epoch seconds (optional).

Example: 1730419200
createdTimestampToint64

Upper bound (inclusive) for createdTimestamp, epoch seconds (optional).

Example: 1733011200
includeDeletedboolean

true — also include soft-deleted notes. Default false.

Default value: false
Example: false
deletedOnlyboolean

true — only soft-deleted notes. Takes precedence over includeDeleted. Default false.

Default value: false
Example: false
LeadNoteFilterDTO
{
  "page": 1,
  "size": 15,
  "orders": {
    "CREATED_TIMESTAMP": "DESC"
  },
  "search": "callback",
  "ids": [
    7001,
    7002
  ],
  "leadIds": [
    1001
  ],
  "createdByIds": [
    95
  ],
  "deletedByIds": [
    95
  ],
  "types": [
    "SIMPLE"
  ],
  "pinned": true,
  "hasFiles": true,
  "createdTimestampFrom": 1730419200,
  "createdTimestampTo": 1733011200,
  "includeDeleted": false,
  "deletedOnly": false
}