Leads

Get Leads

GET https://api.theairr.com/lead

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

Headers

Name	Type	Description
X-API-KEY	string	API key for a particular Organization

200 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": "[e-mail]",
    "website": "robotics.com"
    "leadSourceNames": [
        "Crunchbase", "John Doe", "Website"
    ]
}

Get Lead

GET https://api.theairr.com/lead/:leadId

This endpoints allows you to get information about a particular Lead

Query Parameters

Name	Type	Description
leadId	string	ID of the Lead

Headers

Name	Type	Description
X-API-KEY	string	API key for a particular Organization

200 Lead 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": "[e-mail]",
    "website": "robotics.com"
    "leadSourceNames": [
        "Crunchbase", "John Doe", "Website"
    ]
}

404 Lead not found

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