Get a lead

GET {{HOST}}/api/partner-api/v2/sales/leads/{{external_lead_id}}

Get a sales lead.

Required Scopes

  • sales:leads:view

Notes

  • Sales leads are retrieved for an external_id and a lead_source
  • lead_source is determined by your API key
  • You cannot retrieve other users leads in any way

RESPONSES

status: OK

{"first_name":"First","last_name":"Name","description":"","external_id":"8f297810-0ef1-4b5d-b6e6-533712a141a6","email":"first.name@bellhop.com","phone":"000-000-0000","origin_street":"","origin_city":"","origin_postal_code":"00000","origin_state":"","destination_street":"","destination_city":"","destination_postal_code":"00000","destination_state":"","lead_type":"Long Distance","lead_record_type":"01246000000hs1RAAQ","load_date":"2020-11-18","close_date":null}