Skip to main content

LeadSearchRequest

A reusable set of lead filters (the same filters used by lead search), used here to target a manual sending campaign.

product_idProduct Idrequired

ID of the product (workspace) that owns this record. Most endpoints scope access by product.

id object

Match a single lead by id.

anyOf
integer
lead_idsinteger[]

Match a specific set of lead ids.

stage_idsinteger[]

Match leads in any of these stages.

name object

Match by lead name.

anyOf
string
crm_id object

Identifier of the matching record in the connected external CRM, if any.

anyOf
string
is_active object

Match by active flag.

anyOf
boolean
is_test object

Match by test flag.

anyOf
boolean
created_at_from object

Include leads created at or after this UTC instant.

anyOf
date-time
created_at_to object

Include leads created at or before this UTC instant.

anyOf
date-time
has_started object

True matches leads with started_at set; false matches leads that have not started.

anyOf
boolean
batch_name object

Match by import batch name.

anyOf
string
tag_idsinteger[]

Match leads having any of these tags.

contact object

Match by a contact value.

anyOf
string
crm_fields_conditions object

Composite CRM-field conditions (AND/OR with per-field operators).

anyOf
operatorCRMFieldsConditionsOperator

Possible values: [AND, OR]

Default value: AND
conditions object[]
  • Array [
    • fieldFieldrequired
    operatorCRMFieldConditionOperatorrequired

    Possible values: [EQUALS, NOT_EQUALS, IN, NOT_IN, STARTS_WITH, ENDS_WITH, CONTAINS, EXISTS, NOT_EXISTS, IS_EMPTY, IS_NOT_EMPTY]

    valueValue
  • ]
    • limitLimit

    Possible values: >= 1 and <= 1000

    Default value: 50
    pagePage

    Possible values: >= 1

    Default value: 1
    LeadSearchRequest
    {
      "product_id": 0,
      "id": 0,
      "lead_ids": [
        0
      ],
      "stage_ids": [
        0
      ],
      "name": "string",
      "crm_id": "string",
      "is_active": true,
      "is_test": true,
      "created_at_from": "2024-07-29T15:51:28.071Z",
      "created_at_to": "2024-07-29T15:51:28.071Z",
      "has_started": true,
      "batch_name": "string",
      "tag_ids": [
        0
      ],
      "contact": "string",
      "crm_fields_conditions": {
        "operator": "AND",
        "conditions": [
          {
            "field": "string",
            "operator": "EQUALS"
          }
        ]
      },
      "limit": 50,
      "page": 1
    }