Opportunity
Get opportunity
- 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
Opportunity
Get opportunity
GET
/
api
/
2023-01
/
opportunities
/
{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/opportunities/{id} \
--header 'Authorization: <authorization>'
{
"opportunity": {
"id": "787",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Culver High Rise",
"stage_age": 20,
"probability": 0.5,
"description": "A project to build a high rise in Culver City",
"project_duration": 12,
"pursuit_duration": 90,
"project_number": "23-1329",
"project_status": "active",
"square_feet": 100000,
"price_per_square_foot": 100,
"units": 80,
"price_per_unit": 125000,
"external_id": "external-id-123",
"amount": 10000000,
"award_date": "2023-06-15",
"bid_due_date": "2023-05-22",
"start_date": "2023-09-04",
"end_date": "2024-06-30",
"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"
},
"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>"
},
"import": {
"id": "456",
"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"
},
"loss_reason": {
"id": "254",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Project Canceled"
},
"market_sector": {
"id": "902",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Education"
},
"opp_stage": {
"id": "693",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "<string>",
"category": "open"
},
"custom_fields": {}
}
}
Headers
Authorization
string
requiredPath Parameters
id
string
requiredResponse
200 - application/json
opportunity
object
requiredopportunity.id
string
requiredopportunity.created_at
string
requiredopportunity.updated_at
string
requiredopportunity.name
string
requiredopportunity.stage_age
integer
requiredopportunity.probability
number
requiredopportunity.description
string
requiredopportunity.project_duration
integer
requiredopportunity.pursuit_duration
integer
requiredopportunity.project_number
string
requiredopportunity.project_status
enum<string>
requiredAvailable options:
pursuit
, upcoming
, active
, complete
, lost
opportunity.square_feet
integer | null
requiredopportunity.price_per_square_foot
number | null
requiredopportunity.units
integer | null
requiredopportunity.price_per_unit
number | null
requiredopportunity.external_id
string | null
requiredopportunity.amount
number
requiredopportunity.award_date
string | null
requiredopportunity.bid_due_date
string | null
requiredopportunity.start_date
string | null
requiredopportunity.end_date
string | null
requiredopportunity.address
object
requiredopportunity.address.street_address
string
requiredopportunity.address.street_address2
string
requiredopportunity.address.city
string
requiredopportunity.address.state
string
opportunity.address.zip
string
requiredopportunity.address.country
enum<string>
requiredAvailable options:
AU
, CA
, GB
, IS
, NZ
, UK
, US
opportunity.assigned_to
object | null
requiredopportunity.assigned_to.id
string
requiredopportunity.assigned_to.created_at
string
requiredopportunity.assigned_to.updated_at
string
requiredopportunity.assigned_to.first_name
string
requiredopportunity.assigned_to.last_name
string
requiredopportunity.assigned_to.name
string
requiredopportunity.assigned_to.email
string
requiredopportunity.company
object
requiredopportunity.company.id
string
requiredopportunity.company.created_at
string
requiredopportunity.company.updated_at
string
requiredopportunity.company.name
string
requiredopportunity.company.website
string
requiredopportunity.contact
object | null
requiredopportunity.contact.id
string
requiredopportunity.contact.created_at
string
requiredopportunity.contact.updated_at
string
requiredopportunity.contact.first_name
string
requiredopportunity.contact.last_name
string
requiredopportunity.contact.name
string
requiredopportunity.contact.email
string
requiredopportunity.contract_type
object | null
requiredopportunity.contract_type.id
string
requiredopportunity.contract_type.created_at
string
requiredopportunity.contract_type.updated_at
string
requiredopportunity.contract_type.name
string
requiredopportunity.created_by
object
requiredopportunity.created_by.id
string
requiredopportunity.created_by.created_at
string
requiredopportunity.created_by.updated_at
string
requiredopportunity.created_by.first_name
string
requiredopportunity.created_by.last_name
string
requiredopportunity.created_by.name
string
requiredopportunity.created_by.email
string
requiredopportunity.division
object | null
requiredopportunity.division.id
string
requiredopportunity.division.created_at
string
requiredopportunity.division.updated_at
string
requiredopportunity.division.name
string
requiredopportunity.import
object | null
requiredopportunity.import.id
string
requiredopportunity.import.created_at
string
requiredopportunity.import.updated_at
string
requiredopportunity.import.name
string
requiredopportunity.lead_source
object | null
requiredopportunity.lead_source.id
string
requiredopportunity.lead_source.created_at
string
requiredopportunity.lead_source.updated_at
string
requiredopportunity.lead_source.name
string
requiredopportunity.loss_reason
object | null
requiredopportunity.loss_reason.id
string
requiredopportunity.loss_reason.created_at
string
requiredopportunity.loss_reason.updated_at
string
requiredopportunity.loss_reason.name
string
requiredopportunity.market_sector
object | null
requiredopportunity.market_sector.id
string
requiredopportunity.market_sector.created_at
string
requiredopportunity.market_sector.updated_at
string
requiredopportunity.market_sector.name
string
requiredopportunity.opp_stage
object
requiredopportunity.opp_stage.id
string
requiredopportunity.opp_stage.created_at
string
requiredopportunity.opp_stage.updated_at
string
requiredopportunity.opp_stage.name
string
requiredopportunity.opp_stage.category
enum<string>
requiredAvailable options:
open
, won
, lost
opportunity.custom_fields
object
curl --request GET \
--url https://api.buildr.com/api/2023-01/opportunities/{id} \
--header 'Authorization: <authorization>'
{
"opportunity": {
"id": "787",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Culver High Rise",
"stage_age": 20,
"probability": 0.5,
"description": "A project to build a high rise in Culver City",
"project_duration": 12,
"pursuit_duration": 90,
"project_number": "23-1329",
"project_status": "active",
"square_feet": 100000,
"price_per_square_foot": 100,
"units": 80,
"price_per_unit": 125000,
"external_id": "external-id-123",
"amount": 10000000,
"award_date": "2023-06-15",
"bid_due_date": "2023-05-22",
"start_date": "2023-09-04",
"end_date": "2024-06-30",
"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"
},
"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>"
},
"import": {
"id": "456",
"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"
},
"loss_reason": {
"id": "254",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Project Canceled"
},
"market_sector": {
"id": "902",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Education"
},
"opp_stage": {
"id": "693",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "<string>",
"category": "open"
},
"custom_fields": {}
}
}