Search Knowledge Base Articles

API Guide Items- Leads - Request Lead information

Leads - Request Lead information

GET yourdomain.com/api/leads/:id

Header

json
Field Type Description
Authorization String

Basic Access Authentication token.

Parameter

json
Field Type Description
id Number

Lead unique ID.

Success 200

json
Field Type Description
Lead Object

information.

Error 4xx

json
Name Type Description
status Boolean

Request status.
message String

No data were found.
  • Success-Response:
HTTP/1.1 200 OK
{
    "id": "17",
    "hash": "c6e938f8b7a40b1bcfd98dc04f6eeee0-60d9c039da373a685fc0f74d4bfae631",
    "name": "Lead name",
    "contact": "",
    "title": "",
    "company": "Themesic Interactive",
    "description": "",
    "country": "243",
    "zip": null,
    "city": "London",
    "state": "London",
    "address": "1a The Alexander Suite Silk Point",
    "assigned": "5",
    "dateadded": "2019-07-18 08:59:28",
    "from_form_id": "0",
    "status": "0",
    "source": "4",
    ...
}
  • Error-Response:
HTTP/1.1 404 Not Found
{
  "status": false,
  "message": "No data were found"
}

Did you find this article useful?

Related Articles