Contact
List contacts
- 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
Contact
List contacts
GET
/
api
/
2023-01
/
contacts
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
filters
object
filters
object
id
integer
id
integer
name
string
name
string
email
string
email
string
curl --request GET \
--url https://api.buildr.com/api/2023-01/contacts \
--header 'Authorization: <authorization>'
{
"contacts": [
{
"id": "144",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"email": "austin.reaves@example.com",
"first_name": "Austin",
"last_name": "Reaves",
"name": "Austin Reaves",
"job_title": "Point Guard",
"mobile_phone": "555-555-5555",
"office_phone": "555-555-5555 x301",
"linked_in_profile_url": "https://www.linkedin.com/in/john-doe",
"company": {
"id": "101",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "<string>",
"website": "<string>"
},
"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"
},
"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"
},
"import": {
"id": "456",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "<string>"
},
"custom_fields": {}
}
]
}
Headers
Authorization
string
requiredQuery Parameters
filters
object
filters.id
integer
filters.name
string
filters.email
string
Response
200 - application/json
contacts
object[]
requiredcontacts.id
string
requiredcontacts.created_at
string
requiredcontacts.updated_at
string
requiredcontacts.email
string
requiredcontacts.first_name
string
requiredcontacts.last_name
string
requiredcontacts.name
string
requiredcontacts.job_title
string
requiredcontacts.mobile_phone
string
requiredcontacts.office_phone
string
requiredcontacts.linked_in_profile_url
string
requiredcontacts.company
object
requiredcontacts.company.id
string
requiredcontacts.company.created_at
string
requiredcontacts.company.updated_at
string
requiredcontacts.company.name
string
requiredcontacts.company.website
string
requiredcontacts.assigned_to
object | null
requiredcontacts.assigned_to.id
string
requiredcontacts.assigned_to.created_at
string
requiredcontacts.assigned_to.updated_at
string
requiredcontacts.assigned_to.first_name
string
requiredcontacts.assigned_to.last_name
string
requiredcontacts.assigned_to.name
string
requiredcontacts.assigned_to.email
string
requiredcontacts.created_by
object
requiredcontacts.created_by.id
string
requiredcontacts.created_by.created_at
string
requiredcontacts.created_by.updated_at
string
requiredcontacts.created_by.first_name
string
requiredcontacts.created_by.last_name
string
requiredcontacts.created_by.name
string
requiredcontacts.created_by.email
string
requiredcontacts.import
object | null
requiredcontacts.import.id
string
requiredcontacts.import.created_at
string
requiredcontacts.import.updated_at
string
requiredcontacts.import.name
string
requiredcontacts.custom_fields
object
curl --request GET \
--url https://api.buildr.com/api/2023-01/contacts \
--header 'Authorization: <authorization>'
{
"contacts": [
{
"id": "144",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"email": "austin.reaves@example.com",
"first_name": "Austin",
"last_name": "Reaves",
"name": "Austin Reaves",
"job_title": "Point Guard",
"mobile_phone": "555-555-5555",
"office_phone": "555-555-5555 x301",
"linked_in_profile_url": "https://www.linkedin.com/in/john-doe",
"company": {
"id": "101",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "<string>",
"website": "<string>"
},
"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"
},
"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"
},
"import": {
"id": "456",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "<string>"
},
"custom_fields": {}
}
]
}