Leads

get
Get Leads

https://api.theairr.com/lead
This endpoint allows you to get information about all the Leads in Organization.
Request
Response
Request
Headers
X-API-KEY
required
string
API key for a particular Organization
Response
200: OK
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
Get Lead

https://api.theairr.com/lead/:leadId
This endpoints allows you to get information about a particular Lead
Request
Response
Request
Headers
X-API-KEY
optional
string
API key for a particular Organization
Query Parameters
leadId
optional
string
ID of the Lead
Response
200: OK
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": "abc@robotics.com",
"website": "robotics.com"
"leadSourceNames": [
"Crunchbase", "John Doe", "Website"
]
}
404: Not Found
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"
}

‚Äč