200: OK

REQUIRED

Response

API key for a particular Organization

string

X-API-KEY

Leads
Get Leads
GET

Request

Headers

This endpoint allows you to get information about all the Leads in Organization.

Leads data successfully retrieved.

{
    "id": b8229d06-008d-4881-8732-0dd72901c34e,
    "firstname": "Mike",
    "lastname": "Smith",
    "statusId": c193ce9d-6623-4c1e-a50d-85c8e056a206,
    "statusName": "New",
    "stageType": "In Progress",
    "description": "The greatest potential investment ever",
    "company": "ABC Robotics",
    "amount": 1000000000,
    "email": "abc@robotics.com",
    "website": "robotics.com"
    "leadSourceNames": [
        "Crunchbase", "John Doe", "Website"
    ]
}

Get Opportunity
GET

This endpoints allows you to get information about a particular Lead

Request

REQUIRED

API key for a particular Organization

string

X-API-KEY

Headers

Response

200: OK

Lead data successfully retrieved

Query Parameters

REQUIRED

leadId

string

ID of the Lead

404: Not Found

Lead not found

{
    "id": b8229d06-008d-4881-8732-0dd72901c34e,
    "firstname": "Mike",
    "lastname": "Smith",
    "statusId": c193ce9d-6623-4c1e-a50d-85c8e056a206,
    "statusName": "New",
    "stageType": "In Progress",
    "description": "The greatest potential investment ever",
    "company": "ABC Robotics",
    "amount": 1000000000,
    "email": "abc@robotics.com",
    "website": "robotics.com"
    "leadSourceNames": [
        "Crunchbase", "John Doe", "Website"
    ]
}

{
    "timestamp":"2019-12-02T11:20:17.201+0000",
    "status":404,
    "error":"Not Found",
    "message":"Lead not found",
    "path":"/lead/564745a1-4964-420b-8c32-617737169050"
}

Group 1 (2).png
facebook 1.png
Group.png
linkedin 1.png
Frame 5.png