Skip to main content

LeadSearchRequest

product_idProduct Idrequired

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

id object

Unique numeric identifier of the record.

anyOf
integer
lead_idsinteger[]
stage_idsinteger[]
name object
anyOf
string
crm_id object

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

anyOf
string
is_active object
anyOf
boolean
is_test object
anyOf
boolean
batch_name object
anyOf
string
tag_idsinteger[]
contact object
anyOf
string
crm_fields_conditions object
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,
      "batch_name": "string",
      "tag_ids": [
        0
      ],
      "contact": "string",
      "crm_fields_conditions": {
        "operator": "AND",
        "conditions": [
          {
            "field": "string",
            "operator": "EQUALS"
          }
        ]
      },
      "limit": 50,
      "page": 1
    }