searchLead

Search and return the identifiers of a lead.

Arguments

filters : SearchLeadFilters!


            required

Filters to search for leads. All passed filters will be checked against the lead.

Returns

LeadIdType

Possible Errors

KT-CT-1113: Disabled GraphQL field requested.
KT-CT-7899: An internal error occurred.
KT-CT-8920: Search filters are invalid.

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

Can query leads

Query Complexity

Examples

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

query SearchLead($filters: SearchLeadFilters!) {
  searchLead(filters: $filters) {
    number
  }
}

{
  "filters": SearchLeadFilters
}

{
  "data": {
    "searchLead": {
      "number": "form-develop-white-religious-such"
    }
  }
}