Custom Field
List custom fields
- 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
Custom Field
List custom fields
GET
/
api
/
2023-01
/
custom_fields
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
model
enum<string>
model
enum<string>
curl --request GET \
--url https://api.buildr.com/api/2023-01/custom_fields \
--header 'Authorization: <authorization>'
{
"custom_fields": [
{
"id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"api_name": "custom_field_1",
"category": "text",
"model": "company",
"name": "Custom Field 1"
}
]
}
Headers
Authorization
string
requiredQuery Parameters
filters
object
filters.model
enum<string>
Available options:
company
, contact
, opp
Response
200 - application/json
custom_fields
object[]
requiredcustom_fields.id
string
requiredcustom_fields.created_at
string
requiredcustom_fields.updated_at
string
requiredcustom_fields.api_name
string
requiredcustom_fields.category
enum<string>
requiredAvailable options:
boolean
, choices_single
, choices_multiple
, company_single
, contact_single
, date
, hidden
, long_text
, money
, number
, text
custom_fields.model
enum<string>
requiredAvailable options:
company
, contact
, opp
, custom_activity
custom_fields.name
string
requiredcurl --request GET \
--url https://api.buildr.com/api/2023-01/custom_fields \
--header 'Authorization: <authorization>'
{
"custom_fields": [
{
"id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"api_name": "custom_field_1",
"category": "text",
"model": "company",
"name": "Custom Field 1"
}
]
}