leadByNumber

Get lead details by number.

Arguments

number : String

Lead number.

Returns

LeadOutput

Possible Errors

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 LeadByNumber($number: String) {
  leadByNumber(number: $number) {
    accountNumber
    brand
    contacts {
      ...LeadContactDetailsTypeFragment
    }
    email
    extraDetailItems {
      ...ExtraDetailFragment
    }
    familyName
    funnel {
      ...SalesFunnelFragment
    }
    givenName
    leadId
    leadType
    nationalId
    number
    phoneNumber
    stage
  }
}

{
  "number": "president-require-spring-especially-participant"
}

{
  "data": {
    "leadByNumber": {
      "accountNumber": "A-3DE791BD",
      "brand": "discussion-night-common-smile-term",
      "contacts": [LeadContactDetailsType],
      "email": "form-develop-white-religious-such",
      "extraDetailItems": [ExtraDetail],
      "familyName": "Johnson",
      "funnel": SalesFunnel,
      "givenName": "Rachel",
      "leadId": "93544101",
      "leadType": "I-up-value-eat-especially",
      "nationalId": "19736064",
      "number": "personal-close-win-kitchen-tree",
      "phoneNumber": "rock-paper-energy-money-catch",
      "stage": "catch-resource-guess-seem-drive"
    }
  }
}