Lead
List leads
Call Outcome
Company Category
Contract Type
Custom Field
Delivery Method
Industry
Lead Source
Loss Reason
Market Sector
Project Stages
Task List
Tender Type
Webhook Message
Lead
List leads
GET
/
api
/
2023-01
/
leads
Copy
curl --request GET \
--url https://api.buildr.com/api/2023-01/leads \
--header 'Authorization: <authorization>'
Copy
{
"leads": [
{
"id": "966",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Gateway Logistics Center",
"description": "We have to close this one!",
"priority": true,
"value_in_cents": 2999,
"estimated_start_date": "2023-09-04",
"construction_duration": 4,
"construction_duration_unit": "days",
"square_feet": 1200,
"units": 24,
"archived_at": "2023-02-14T18:13:00Z",
"snooze_until": "2023-02-14T18:13:00Z",
"work_scope": "new_construction",
"address": {
"street_address": "123 Main St",
"street_address2": "Apt 1",
"city": "Los Angeles",
"state": "CA",
"zip": "90001",
"country": "US"
},
"assigned_to": {
"id": "953",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"first_name": "Russell",
"last_name": "Westbrook",
"name": "Russell Westbrook",
"email": "russell.westbrook@example.com"
},
"archived_by": {
"id": "953",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"first_name": "Russell",
"last_name": "Westbrook",
"name": "Russell Westbrook",
"email": "russell.westbrook@example.com"
},
"company": {
"id": "101",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "<string>",
"website": "<string>"
},
"contact": {
"id": "418",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"first_name": "Austin",
"last_name": "Reaves",
"name": "Austin Reaves",
"email": "austin.reaves@example.com"
},
"contract_type": {
"id": "721",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Design/Build"
},
"created_by": {
"id": "953",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"first_name": "Russell",
"last_name": "Westbrook",
"name": "Russell Westbrook",
"email": "russell.westbrook@example.com"
},
"delivery_method": {
"id": "306",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Design Build"
},
"division": {
"id": "689",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "<string>"
},
"lead_source": {
"id": "346",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Website"
},
"market_sector": {
"id": "902",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Education"
},
"tender_type": {
"id": "588",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Open"
}
}
]
}
Headers
Response
200 - application/json
Successful Response
Example:
"966"
Example:
"2023-02-14T18:13:00Z"
Example:
"2023-04-03T20:16:30Z"
Example:
"Gateway Logistics Center"
Example:
"953"
Example:
"2023-02-14T18:13:00Z"
Example:
"2023-04-03T20:16:30Z"
Example:
"Russell"
Example:
"Westbrook"
Example:
"Russell Westbrook"
Example:
"russell.westbrook@example.com"
Example:
"418"
Example:
"2023-02-14T18:13:00Z"
Example:
"2023-04-03T20:16:30Z"
Example:
"Austin"
Example:
"Reaves"
Example:
"Austin Reaves"
Example:
"austin.reaves@example.com"
Example:
"953"
Example:
"2023-02-14T18:13:00Z"
Example:
"2023-04-03T20:16:30Z"
Example:
"Russell"
Example:
"Westbrook"
Example:
"Russell Westbrook"
Example:
"russell.westbrook@example.com"
Example:
"We have to close this one!"
Example:
true
Example:
2999
Example:
"2023-09-04"
Example:
4
Available options:
, days
, weeks
, months
Example:
"days"
Example:
1200
Example:
24
Example:
"2023-02-14T18:13:00Z"
Example:
"2023-02-14T18:13:00Z"
Available options:
, new_construction
, renovation
, maintenance
Example:
"new_construction"
Example:
"123 Main St"
Example:
"Apt 1"
Example:
"Los Angeles"
Example:
"90001"
Available options:
AU
, CA
, GB
, IS
, NZ
, UK
, US
Example:
"US"
Example:
"CA"
Example:
"953"
Example:
"2023-02-14T18:13:00Z"
Example:
"2023-04-03T20:16:30Z"
Example:
"Russell"
Example:
"Westbrook"
Example:
"Russell Westbrook"
Example:
"russell.westbrook@example.com"
Copy
curl --request GET \
--url https://api.buildr.com/api/2023-01/leads \
--header 'Authorization: <authorization>'
Copy
{
"leads": [
{
"id": "966",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Gateway Logistics Center",
"description": "We have to close this one!",
"priority": true,
"value_in_cents": 2999,
"estimated_start_date": "2023-09-04",
"construction_duration": 4,
"construction_duration_unit": "days",
"square_feet": 1200,
"units": 24,
"archived_at": "2023-02-14T18:13:00Z",
"snooze_until": "2023-02-14T18:13:00Z",
"work_scope": "new_construction",
"address": {
"street_address": "123 Main St",
"street_address2": "Apt 1",
"city": "Los Angeles",
"state": "CA",
"zip": "90001",
"country": "US"
},
"assigned_to": {
"id": "953",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"first_name": "Russell",
"last_name": "Westbrook",
"name": "Russell Westbrook",
"email": "russell.westbrook@example.com"
},
"archived_by": {
"id": "953",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"first_name": "Russell",
"last_name": "Westbrook",
"name": "Russell Westbrook",
"email": "russell.westbrook@example.com"
},
"company": {
"id": "101",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "<string>",
"website": "<string>"
},
"contact": {
"id": "418",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"first_name": "Austin",
"last_name": "Reaves",
"name": "Austin Reaves",
"email": "austin.reaves@example.com"
},
"contract_type": {
"id": "721",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Design/Build"
},
"created_by": {
"id": "953",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"first_name": "Russell",
"last_name": "Westbrook",
"name": "Russell Westbrook",
"email": "russell.westbrook@example.com"
},
"delivery_method": {
"id": "306",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Design Build"
},
"division": {
"id": "689",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "<string>"
},
"lead_source": {
"id": "346",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Website"
},
"market_sector": {
"id": "902",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Education"
},
"tender_type": {
"id": "588",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Open"
}
}
]
}