Workforce
Create employee
- 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
Workforce
Create employee
POST
/
api
/
2023-01
/
workforce
/
employees
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
object
workforce_employee
object
workforce_employee
object
birthday
string
birthday
string
Add Example Value
email
string
*
email
Required
string
Add Example Value
last_name
string
*
last_name
Required
string
Add Example Value
legal_first_name
string
*
legal_first_name
Required
string
Add Example Value
notes
string
notes
string
Add Example Value
phone
string
phone
string
Add Example Value
preferred_first_name
string
preferred_first_name
string
Add Example Value
role_id
string
*
role_id
Required
string
Role ID to be associated with this employee
Add Example Value
start_date
string
*
start_date
Required
string
Add Example Value
address
object
address
object
street_address
string
*
street_address
Required
string
Add Example Value
street_address2
string
*
street_address2
Required
string
Add Example Value
city
string
*
city
Required
string
Add Example Value
state
string
state
string
Add Example Value
zip
string
*
zip
Required
string
Add Example Value
country
enum<string>
*
country
Required
enum<string>
Add Example Value
curl --request POST \
--url https://api.buildr.com/api/2023-01/workforce/employees \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"workforce_employee": {
"birthday": "2021-01-01",
"email": "anthony@example.com",
"last_name": "Edwards",
"legal_first_name": "Anthony",
"notes": "This is why you always leave a note",
"phone": "555-555-5555",
"preferred_first_name": "Tony",
"role_id": "734",
"start_date": "2021-01-01",
"address": {
"street_address": "123 Main St",
"street_address2": "Apt 1",
"city": "Los Angeles",
"state": "CA",
"zip": "90001",
"country": "US"
}
}
}'
{
"workforce_employee": {
"id": "140",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"birthday": "2021-01-01",
"last_name": "Edwards",
"legal_first_name": "Anthony",
"notes": "This is why you always leave a note",
"phone": "555-555-5555",
"preferred_first_name": "Tony",
"start_date": "2021-01-01",
"email": "anthony@example.com",
"address": {
"street_address": "123 Main St",
"street_address2": "Apt 1",
"city": "Los Angeles",
"state": "CA",
"zip": "90001",
"country": "US"
},
"role": {
"id": "734",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Project Manager",
"abbreviation": "PM"
}
}
}
Headers
Authorization
string
requiredBody
application/json
workforce_employee
object
workforce_employee.birthday
string
workforce_employee.email
string
requiredworkforce_employee.last_name
string
requiredworkforce_employee.legal_first_name
string
requiredworkforce_employee.notes
string
workforce_employee.phone
string
workforce_employee.preferred_first_name
string
workforce_employee.role_id
string
requiredRole ID to be associated with this employee
workforce_employee.start_date
string
requiredworkforce_employee.address
object
workforce_employee.address.street_address
string
requiredworkforce_employee.address.street_address2
string
requiredworkforce_employee.address.city
string
requiredworkforce_employee.address.state
string
workforce_employee.address.zip
string
requiredworkforce_employee.address.country
enum<string>
requiredAvailable options:
AU
, CA
, GB
, IS
, NZ
, UK
, US
Response
201 - application/json
workforce_employee
object
requiredworkforce_employee.id
string
requiredworkforce_employee.created_at
string
requiredworkforce_employee.updated_at
string
requiredworkforce_employee.birthday
string | null
requiredworkforce_employee.last_name
string
requiredworkforce_employee.legal_first_name
string
requiredworkforce_employee.notes
string
requiredworkforce_employee.phone
string
requiredworkforce_employee.preferred_first_name
string
requiredworkforce_employee.start_date
string
requiredworkforce_employee.email
string
requiredworkforce_employee.address
object
requiredworkforce_employee.address.street_address
string
requiredworkforce_employee.address.street_address2
string
requiredworkforce_employee.address.city
string
requiredworkforce_employee.address.state
string
workforce_employee.address.zip
string
requiredworkforce_employee.address.country
enum<string>
requiredAvailable options:
AU
, CA
, GB
, IS
, NZ
, UK
, US
workforce_employee.role
object
requiredworkforce_employee.role.id
string
requiredworkforce_employee.role.created_at
string
requiredworkforce_employee.role.updated_at
string
requiredworkforce_employee.role.name
string
requiredworkforce_employee.role.abbreviation
string
requiredcurl --request POST \
--url https://api.buildr.com/api/2023-01/workforce/employees \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"workforce_employee": {
"birthday": "2021-01-01",
"email": "anthony@example.com",
"last_name": "Edwards",
"legal_first_name": "Anthony",
"notes": "This is why you always leave a note",
"phone": "555-555-5555",
"preferred_first_name": "Tony",
"role_id": "734",
"start_date": "2021-01-01",
"address": {
"street_address": "123 Main St",
"street_address2": "Apt 1",
"city": "Los Angeles",
"state": "CA",
"zip": "90001",
"country": "US"
}
}
}'
{
"workforce_employee": {
"id": "140",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"birthday": "2021-01-01",
"last_name": "Edwards",
"legal_first_name": "Anthony",
"notes": "This is why you always leave a note",
"phone": "555-555-5555",
"preferred_first_name": "Tony",
"start_date": "2021-01-01",
"email": "anthony@example.com",
"address": {
"street_address": "123 Main St",
"street_address2": "Apt 1",
"city": "Los Angeles",
"state": "CA",
"zip": "90001",
"country": "US"
},
"role": {
"id": "734",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Project Manager",
"abbreviation": "PM"
}
}
}