Lead
Get lead
- Introduction
- API Reference
- GETList call outcomes
- GETList company categories
- GETList contract types
- GETList custom fields
- GETList industries
- GETList lead sources
- GETList loss reasons
- GETList market sectors
- POSTCreate opportunity
- PATCHUpdate opportunity
- GETList opportunities
- GETGet opportunity
- DELDelete opportunity
- GETList opp stages
Call Outcome
Company Category
Contract Type
Custom Field
Industry
Lead Source
Loss Reason
Market Sector
Opportunity
Opp Stage
Lead
Get lead
GET
/
api
/
2023-01
/
leads
/
{id}
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Authorization
string
*
Authorization
Required
string
id
string
*
id
Required
string
curl --request GET \
--url https://api.buildr.com/api/2023-01/leads/{id} \
--header 'Authorization: <authorization>'
{
"lead": {
"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",
"tender_type": "open",
"delivery_method": "cmar",
"square_feet": 1200,
"units": 24,
"archived_at": "2023-02-14T18:13:00Z",
"snooze_until": "2023-02-14T18:13:00Z",
"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"
},
"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"
}
}
}
Headers
Authorization
string
requiredPath Parameters
id
string
requiredResponse
200 - application/json
lead
object | null
requiredlead.id
string
requiredlead.created_at
string
requiredlead.updated_at
string
requiredlead.name
string
requiredlead.description
string
lead.priority
boolean
lead.value_in_cents
integer | null
lead.estimated_start_date
string | null
lead.construction_duration
integer | null
lead.construction_duration_unit
enum<string>
Available options:
, days
, weeks
, months
lead.tender_type
enum<string>
Available options:
, open
, selective
, negotiated
lead.delivery_method
enum<string>
Available options:
, design_bid_build
, design_build
, cmar
lead.square_feet
integer | null
lead.units
integer | null
lead.archived_at
string | null
lead.snooze_until
string | null
lead.address
object
lead.address.street_address
string
requiredlead.address.street_address2
string
requiredlead.address.city
string
requiredlead.address.state
string
lead.address.zip
string
requiredlead.address.country
enum<string>
requiredAvailable options:
AU
, CA
, GB
, IS
, NZ
, UK
, US
lead.assigned_to
object | null
requiredlead.assigned_to.id
string
requiredlead.assigned_to.created_at
string
requiredlead.assigned_to.updated_at
string
requiredlead.assigned_to.first_name
string
requiredlead.assigned_to.last_name
string
requiredlead.assigned_to.name
string
requiredlead.assigned_to.email
string
requiredlead.archived_by
object | null
lead.archived_by.id
string
requiredlead.archived_by.created_at
string
requiredlead.archived_by.updated_at
string
requiredlead.archived_by.first_name
string
requiredlead.archived_by.last_name
string
requiredlead.archived_by.name
string
requiredlead.archived_by.email
string
requiredlead.company
object | null
requiredlead.company.id
string
requiredlead.company.created_at
string
requiredlead.company.updated_at
string
requiredlead.company.name
string
requiredlead.company.website
string
requiredlead.contact
object | null
requiredlead.contact.id
string
requiredlead.contact.created_at
string
requiredlead.contact.updated_at
string
requiredlead.contact.first_name
string
requiredlead.contact.last_name
string
requiredlead.contact.name
string
requiredlead.contact.email
string
requiredlead.contract_type
object | null
requiredlead.contract_type.id
string
requiredlead.contract_type.created_at
string
requiredlead.contract_type.updated_at
string
requiredlead.contract_type.name
string
requiredlead.created_by
object
requiredlead.created_by.id
string
requiredlead.created_by.created_at
string
requiredlead.created_by.updated_at
string
requiredlead.created_by.first_name
string
requiredlead.created_by.last_name
string
requiredlead.created_by.name
string
requiredlead.created_by.email
string
requiredlead.division
object | null
requiredlead.division.id
string
requiredlead.division.created_at
string
requiredlead.division.updated_at
string
requiredlead.division.name
string
requiredlead.lead_source
object | null
requiredlead.lead_source.id
string
requiredlead.lead_source.created_at
string
requiredlead.lead_source.updated_at
string
requiredlead.lead_source.name
string
requiredlead.market_sector
object | null
requiredlead.market_sector.id
string
requiredlead.market_sector.created_at
string
requiredlead.market_sector.updated_at
string
requiredlead.market_sector.name
string
requiredcurl --request GET \
--url https://api.buildr.com/api/2023-01/leads/{id} \
--header 'Authorization: <authorization>'
{
"lead": {
"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",
"tender_type": "open",
"delivery_method": "cmar",
"square_feet": 1200,
"units": 24,
"archived_at": "2023-02-14T18:13:00Z",
"snooze_until": "2023-02-14T18:13:00Z",
"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"
},
"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"
}
}
}