Getting Started

Overview

The REST APIs provide programmatic access to read and write TempBuddy data.

Before using the API you need to request your credentials. You can do it from the admin settings panel in TempBuddy.

Basic Information

All calls are done using POST or GET methods.

All content, unless specified, must be send as Form Data (application/x-www-form-urlencoded).

All response, unless specified, are in JSON. Some exceptions are: Profile Pictures and Files.

Authentication

Get API Credentials from admin settings panel.

Send the client_id and client_secret as body parameters in each request.

Examples

You can have a look to the Api Example Section to know how to call the API.

Parameters: Formats and Operators

Operators usually work as: parameter=value and parameter_op=operator

Some types available:

[type]:Array of elements of type 'type'

Some operators available:

multi: allows to send only one value or multiple separated by comma.
eq: search for entities with that value in that parameter.
LIKE: search for entities that contains that value in that field.
=,<,>,<=,>=: Operators for number. It does the comparison as tempbuddy_value 'op' parameter_value

Sort

If request allows to sort data it should be as:

Parameter Name: orderBy
Parameter Value: 'field_to_sort' 'direction'. Ex: orderBy=name ASC.

Allowed directions are: ASC or DESC.

Show/hide List Operations Expand Operations

AgencyApprovers

GET /apiC/1.0/agencyApprovers.json stable

Get the list of agency approvers.

Documentation
Sandbox

Documentation

Get the list of agency approvers.

Status Codes

Status Code	Description
200	Returned when successful
300	No entity validated
350	No action validated
400	No parameters validated

Input

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

Show/hide List Operations Expand Operations

Application

GET /apiC/1.0/application.json stable

Gets the application information.

Documentation
Request
Response
Sandbox

Documentation

[GET]/application.json: Gets the application information.

Status Codes

Status Code	Description
200	Returned when successful
300	No entity validated
350	No action validated
400	No parameters validated

Parameters

Parameter	Type	Required	Operators	Example	Description
ids	integer	false	multi		id/ids(comma separated)
modifiedAfter	datetime	false		YYYY-MM-DD HH:mm:ss	Entities created or modified after specific date time (in UTC)
orderBy	integer	false	id,id		OrderBy
page	integer	false			Offset or initial page index to retrieve entites. First element will be: page * limit
limit	integer	false			Total of entities to retrieve

Return

Parameter

Type

Description

code

integer

Status code of the request

data

collection

Result of the operation

data (collection : Result of the operation)

Parameter

Type

Description

job

collection

Job information

job (collection : Job information)

Parameter	Type	Description
id	integer	Job ID
value	string	Job name

candidate

collection

candidate information

candidate (collection : candidate information)

Parameter	Type	Description
id	integer	Candidate ID
value	string	Candidate name

date

string

Date of creation

status

string

Application status

integer

Application ID

modifiedOn

string

Date of last update

Input

Parameters

=> multi integer Optional

=> datetime Optional

=> integer Optional

Order By

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /apiC/1.0/application/post.json stable

Insert an application

Documentation
Request
Response
Sandbox

Documentation

[POST]/application/post.json: Insert an application.

Status Codes

Status Code	Description
200	Returned when successful
300	No entity validated
350	No action validated
400	No parameters validated

Parameters

Parameter	Type	Required	Description
jobID	integer	true	Job id
candidateID	integer	true	candidate id
info	string	false	Any extra information to send with the application
status	string	true	Values allowed: ACCEPTED, APPLIED, REJECTED, IN_RESERVE

Return

Parameter

Type

Description

code

integer

Status code of the request

data

collection

Result of the operation (error string or object data)

data (collection : Result of the operation (error string or object data))

Parameter	Type	Description
count	integer	Number of records affected
results	integer	ID of newly created application

Input

Parameters

=> integer Required

=> string Optional

=> string Required

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

PUT /apiC/1.0/application/put.json stable

Update an application

Documentation
Request
Response
Sandbox

Documentation

[PUT]/application/put.json: Update an application.

Status Codes

Status Code	Description
200	Returned when successful
300	No entity validated
350	No action validated
400	No parameters validated

Parameters

Parameter	Type	Required	Description
id	integer	true	Application id
info	string	false	Any extra information to send with the application
status	string	false	Values allowed: ACCEPTED, APPLIED, REJECTED, IN_RESERVE
sendEmailCandidate	boolean	false	Send notification email to candidate

Return

Parameter

Type

Description

code

integer

Status code of the request

data

collection

Result of the operation

data (collection : Result of the operation)

Parameter	Type	Description
status	string	Status of the request ('updated')
error	string	If present, short error description
error_description	string	If present, long error description
assignment_id	integer	If status update is 'ACCEPTED', created assignment ID

Input

Parameters

=> integer Required

=> string Optional

=> boolean Optional

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

Show/hide List Operations Expand Operations

Assignment

GET /apiC/1.0/assignment.json stable

Gets the assignment information.

Documentation
Request
Response
Sandbox

Documentation

[GET]/assignment.json: Gets the assignment information.

Status Codes

Status Code	Description
200	Returned when successful
300	No entity validated
350	No action validated
400	No parameters validated

Parameters

Parameter	Type	Required	Operators	Example	Description
ids	integer	false	multi		assignment id
candidateID	integer	false	multi		Candidate Id
clientID	integer	false	multi		Client Id
modifiedAfter	datetime	false		YYYY-MM-DD HH:mm:ss	Entities created or modified after specific date time (in UTC)
orderBy	integer	false	id,state		OrderBy
page	integer	false			Offset or initial page index to retrieve entites. First element will be: page * limit
limit	integer	false			Total of entities to retrieve

Return

Parameter

Type

Description

code

integer

Status code of the request

page

integer

Number of the page of paginated results

limit

integer

Limit of row per page result

data

collection

Result of the request

data (collection : Result of the request)

Parameter

Type

Description

count

integer

Number of results returned

results

Assignment[]

List of Assignments

results (Assignment[] : List of Assignments)

Parameter

Type

Description

integer

ID of the assignment

jobID

integer

ID of related job

clientID

integer

ID of the client

locationID

string

UUID of assignment location

templateID

integer

ID of billing template

awrTemplateID

integer

ID of AWR template

clientConfirm

integer

Client confirmation for the assignment

candidateID

integer

ID of assigned worker

candidateConfirm

integer

Worker confirmation for the assignment

State

array

State of assignment

comment

array

Custom message for assignment on creation

created

DateTime

Date of job creation

billingType

string

Type of billing associated to the job

payRate

double

Payrate of the job

margin

double

Margin

taxes

double

Taxes

taxes1

double

Taxes

taxes2

double

Taxes

taxes3

double

Taxes

taxes4

double

Taxes

taxes5

double

Taxes

taxes6

double

Taxes

taxes7

double

Taxes

taxesHolidays

double

Taxes

wcClassCode

string

wcStateRef

string

wcCalculatedTax

double

taxesNumHolidays

integer

billRate

double

Bill rate

currency

string

Symbol of currency

currencyCode

string

Currency code following ISO 4217 format

feeFrequency

enum

Fee frecuency (daily, hourly, weekly, monthly)

bookingFee

double

Booking Fee

profit

double

Client profit

total

double

Total invoice amount for this assignment

startDay

Date

Start day of job

startHour

Time

Start hour of job

hours

double

Total hours of work in related job

days

integer

Number of different days this assignment's job is in

weeks

integer

Number of different weeks this assignment's job is in

pattern

string

Job pattern

finish

DateTime

End date for job

creator

integer

ID of user

strictPayment

integer

strictPaymentOut

integer

fixPaymentIn

integer

fixPaymentOut

integer

requiredPictureCheckIn

integer

Specify if check-in selfie is required for this job

requiredPictureCheckOut

integer

Specify if check-out selfie is required for this job

minimumHoursPerShift

integer

Minumum hours per shift

title

string

Job title

externalRef

string

Job external reference

description

string

Job description

limitedAddress

string

Address of job

overwritePayrate

integer

externalRefObject

string

modifiedOn

DateTime

Date of last modification

timetable

mandatoryBreakDeduction

Time

mandatoryBreakInMinutes

integer

minimumShiftDuration

Time

minimumShiftDurationInMinutes

integer

shifts

string

Collection o shifts for related job, as JSON string

files

array

Array of files ID related with this client

customAttributes

array

Array of custom attributes (as strings) that the job have

customAttributes (array : Array of custom attributes (as strings) that the job have)

Parameter	Type	Description
attr	integer	ID of the custom attribute
value	string	value of the custom attribute
text	string	Description text of the custom attribute
id	integer	ID of the custom attribute field
name	string	Name of the custom attribute
entityID	integer	Entity ID of the attribute
listID	integer	List ID to witch it belongs

owner

collection

Client's owner

owner (collection : Client's owner)

Parameter	Type	Description
id	integer	ID of the owner type
type	string	Type of owner (either RECRUITER or TEAM)

Input

Parameters

=> multi integer Optional

=> datetime Optional

=> integer Optional

Order By

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

PUT /apiC/1.0/assignment/cancel/put.json stable

Cancel an assignment

Documentation
Request
Sandbox

Documentation

[PUT]/assignment/cancel/put.json: Cancel an assignment.

Status Codes

Status Code	Description
200	Returned when successful
300	No entity validated
350	No action validated
400	No parameters validated

Parameters

Parameter	Type	Required	Description
id	integer	true	Local Assignment id
notifyClient	boolean	true	Send email to Client
notifyCandidate	boolean	true	Send email to Candidate

Input

Parameters

=> integer Required

=> boolean Required

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

DELETE /apiC/1.0/assignment/delete.json stable

Cancel or stop an assignment

Documentation
Request
Sandbox

Documentation

[DELETE]/assignment/delete.json: Delete an assignment. Assignments may be cancelled in some cases and an already cancelled assignment cannot be deleted.

Status Codes

Status Code	Description
200	Returned when successful
300	No entity validated
350	No action validated
400	No parameters validated

Parameters

Parameter	Type	Required	Operators	Example	Description
id	integer	true			Local Assignment id

Input

Parameters

=> integer Required

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /apiC/1.0/assignment/post.json stable

Insert an assignment

Documentation
Request
Sandbox

Documentation

Insert an Assignment.

Any optional field that is not specied in the request will be copied from the job.

Status Codes

Status Code	Description
200	Returned when successful
300	No entity validated
350	No action validated
400	No parameters validated

Parameters

Parameter	Type	Required	Operators	Example	Description
jobID	integer	true			assignment ID
candidateID	integer	true			Candidate ID
title	string	false			Title
comment	string	false			Extra comment
autoConfirmCandidate	boolean	false			Auto confirm candidate
autoConfirmClient	boolean	false			Auto confirm client
sendEmailClient	boolean	false			Send notification email to client
locationID	string	false			[Job Field] Location UUID
strictPayment	integer	false			[Job Field] Strict Payment on check in
strictPaymentOut	integer	false			[Job Field] Strict Payment on check out
fixPaymentIn	integer	false			[Job Field] Fix/align Payment on check in
fixPaymentOut	integer	false			[Job Field] Fix/align Payment on check out
minimumHoursPerShift	integer	false			[Job Field] Minimum hours per shift
overwritePayrateWithCand	integer	false			[Job Field] Overwrite Job's pay rate with Candidate's pay rate
requiredPictureCheckIn	integer	false			Set up mandatory picture on check in
requiredPictureCheckOut	integer	false			Set up mandatory picture on check out
description	string	false			[Job Field] Description
templateID	string	false			[Job Field] Complex billing template id
awrTemplateID	integer	false			[Job Field] AWR template id
billingType	string	false			[Job Field] Billing method. Enum with values 'HOURLY' or 'DAILY'
payrate	double	false			[Job Field] Pay rate per hour/day
margin	double	false			[Job Field] % Margin or markup. it must be between 0 and 1.
taxes	double	false			[Job Field] % Total taxes and costs . It must be between 0 and 1
taxes1	double	false			[Job Field] % Tax or cost 1. It must be between 0 and 1.
taxes2	double	false			[Job Field] % Tax or cost 2. It must be between 0 and 1.
taxes3	double	false			[Job Field] % Tax or cost 3. It must be between 0 and 1.
taxes4	double	false			[Job Field] % Tax or cost 4. It must be between 0 and 1.
taxes5	double	false			[Job Field] % Tax or cost 5. It must be between 0 and 1.
taxes6	double	false			[Job Field] % Tax or cost 6. It must be between 0 and 1.
taxes7	double	false			[Job Field] % Tax or cost 7. It must be between 0 and 1.
taxesHolidays	double	false			[Job Field] % Tax or cost according to holidays. It must be between 0 and 1.
taxesNumHolidays	double	false			[Job Field] Number of holidays that worker should be entitled per year.
billrate	double	false			[Job Field] Bill Rate rate per hour/day
bookingFee	double	false			[Job Field] Booking Fee to be applied
feeFrequency	string	false			[Job Field] Fee frequency. Available values: HOURLY, DAILY.
shifts[]	[datetime]	false		["2016-01-01 09:00:00", "2016-01-01 17:00:00", "2016-01-02 09:00:00", "2016-01-02 17:00:00"]	[Job Field] Shifts with dates and hours of work. This array will define the pattern for each week and it will be repeated according to the number of weeks. An array of dates, where they are paired by start and end times, as "start_date", "end_date", "start_date", "end_date", ...
numberWeeks	int	false			[Job Field] Duration of the job in number of weeks. The amount of weeks that pattern will be repeated.
attributes	array	false		[[attribute_id, "attribute_value"], [attribute_id, attribute_list_value_id], [...]]	Custom Attributes to set up, it is an array of pairs 'attribute_id, value'. In case attribute type is a list the attribute value id has to be sent as value.
externalRef	string	false			[Job Field] External Reference
approvers	integer	false	multi		[Job Field] Unique id or list of ids of Agency Approvers.
approversContact	integer	false	multi		[Job Field] Unique id or list of ids of Client Contact that will be approvers.
owner[id]	integer	false			Ownership ID which must be the owner ID
owner[type]	string	false			Ownership type which could be 'RECRUITER' or 'TEAM' (without quoutes)
timesheetGeneration	boolean	false			Enable or disable the timesheet generation funcions
timeCapture	boolean	false			Enable or disable the time capture functions

Input

Parameters

=> integer Required

=> string Optional

=> boolean Optional

=> string Optional

=> integer Optional

=> string Optional

=> integer Optional

=> string Optional

=> double Optional

=> string Optional

=> [datetime] Optional

=> int Optional

=> array Optional

=> string Optional

=> multi integer Optional

=> integer Optional

=> string Optional

=> boolean Optional

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

PUT /apiC/1.0/assignment/put.json stable

Update an assignment

Documentation
Request
Sandbox

Documentation

Update an Assignment.

Status Codes

Status Code	Description
200	Returned when successful
300	No entity validated
350	No action validated
400	No parameters validated

Parameters

Parameter	Type	Required	Operators	Example	Description
id	integer	true			Local Assignment ID
title	string	false			Title
comment	string	false			Extra comment
strictPayment	integer	false			Strict Payment on check in
strictPaymentOut	integer	false			Strict Payment on check out
fixPaymentIn	integer	false			Fix/align Payment on check in
fixPaymentOut	integer	false			Fix/align Payment on check out
minimumHoursPerShift	integer	false			Minimum hours per shift
requiredPictureCheckIn	integer	false			Set up mandatory picture on check in
requiredPictureCheckOut	integer	false			Set up mandatory picture on check out
description	string	false			Description
templateID	string	false			Complex billing template id
awrTemplateID	integer	false			AWR template id
billingType	string	false			Billing method. Enum with values 'HOURLY' or 'DAILY'
payrate	double	false			Pay rate per hour/day
margin	double	false			% Margin or markup. it must be between 0 and 1.
taxes	double	false			% Total taxes and costs . It must be between 0 and 1
taxes1	double	false			% Tax or cost 1. It must be between 0 and 1.
taxes2	double	false			% Tax or cost 2. It must be between 0 and 1.
taxes3	double	false			% Tax or cost 3. It must be between 0 and 1.
taxes4	double	false			% Tax or cost 4. It must be between 0 and 1.
taxes5	double	false			% Tax or cost 5. It must be between 0 and 1.
taxes6	double	false			% Tax or cost 6. It must be between 0 and 1.
taxes7	double	false			% Tax or cost 7. It must be between 0 and 1.
taxesHolidays	double	false			% Tax or cost according to holidays. It must be between 0 and 1.
taxesNumHolidays	double	false			Number of holidays that worker should be entitled per year.
billrate	double	false			Bill Rate rate per hour/day
bookingFee	double	false			Booking Fee to be applied
feeFrequency	string	false			Fee frequency. Available values: HOURLY, DAILY.
shifts[]	[datetime]	false		["2016-01-01 09:00:00", "2016-01-01 17:00:00", "2016-01-02 09:00:00", "2016-01-02 17:00:00"]	Shifts with dates and hours of work. This array will define the pattern for each week and it will be repeated according to the number of weeks. An array of dates, where they are paired by start and end times, as "start_date", "end_date", "start_date", "end_date", ...
numberWeeks	int	false			Duration of the job in number of weeks. The amount of weeks that pattern will be repeated.
addAttributes	array	false		[[attribute_id, "attribute_value"], [attribute_id, attribute_list_value_id], [...]]	Custom Attributes with format [[id, value], [...], ...]. If attribute is a list the value must be the attr value id
removeAttributes	array	false			Custom Attributes ids to be removed
externalRef	string	false			External Ref
owner[id]	integer	false			Ownership ID which must be the owner ID
owner[type]	string	false			Ownership type which could be 'RECRUITER' or 'TEAM' (without quoutes)
approvers	integer	false	multi		It will replace the current approvers. Unique id or list of ids of Agency Approvers. Send 0 to delete all.
approversContact	integer	false	multi		It will replace the current client contact approvers. Unique id or list of ids of Client Contact that will be approvers. Send 0 to delete all.
confirmCandidate	boolean	false			Confirm Candidate in case he/she has not confirmed yet.
confirmClient	boolean	false			Confirm Client in case he/she has not confirmed yet.

Input

Parameters

=> integer Required

=> string Optional

=> integer Optional

=> string Optional

=> integer Optional

=> string Optional

=> double Optional

=> string Optional

=> [datetime] Optional

=> int Optional

=> array Optional

=> string Optional

=> integer Optional

=> string Optional

=> multi integer Optional

=> boolean Optional

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

PUT /apiC/1.0/assignment/recover/put.json stable

Recover an assignment

Documentation
Request
Sandbox

Documentation

[PUT]/assignment/recover/put.json: Recover a cancelled assignment.

Status Codes

Status Code	Description
200	Returned when successful
300	No entity validated
350	No action validated
400	No parameters validated

Parameters

Parameter	Type	Required	Description
id	integer	true	Local Assignment id
autoConfirmCandidate	boolean	false	Autoconfirm candidate. If not specified, already existing value will be inherited from assignemnt.
autoConfirmClient	boolean	false	Autoconfirm client. If not specified, already existing value will be inherited from assignemnt.
sendClientEmail	boolean	false	Send email to client. If not specified, it will be set to false.

Input

Parameters

=> integer Required

=> boolean Optional

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

Show/hide List Operations Expand Operations

Branch

GET /apiC/1.0/branch.json stable

Gets the branches information.

Documentation
Request
Sandbox

Documentation

Gets the comment information.

Status Codes

Status Code	Description
200	Returned when successful
300	No entity validated
350	No action validated
400	No parameters validated

Parameters

Parameter	Type	Required	Operators	Example	Description
ids	integer	false	multi		id/ids(comma separated)
name	string	false	LIKE,eq		Branch name

Input

Parameters

=> multi integer Optional

=> string Optional

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

DELETE /apiC/1.0/branch/delete.json stable

Delete a branch

Documentation
Request
Sandbox

Documentation

Delete a comment.

Status Codes

Status Code	Description
200	Returned when successful
300	No entity validated
350	No action validated
400	No parameters validated

Parameters

Parameter	Type	Required	Operators	Example	Description
id	integer	true			The Branch id

Input

Parameters

=> integer Required

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /apiC/1.0/branch/post.json stable

Add a branch

Documentation
Request
Sandbox

Documentation

Add a comment.

Status Codes

Status Code	Description
200	Returned when successful
300	No entity validated
350	No action validated
400	No parameters validated

Parameters

Parameter	Type	Required	Description
name	string	true	Branch name
description	string	true	Branch description
agencyDefault	boolean	false	If the branch is the agency default branch
active	boolean	false	If the branch is active
readOnly	boolean	false	If the branch is read only

Input

Parameters

=> string Required

=> boolean Optional

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

PUT /apiC/1.0/branch/put.json stable

Edit a branch

Documentation
Request
Sandbox

Documentation

Edit a comment.

Status Codes

Status Code	Description
200	Returned when successful
300	No entity validated
350	No action validated
400	No parameters validated

Parameters

Parameter	Type	Required	Description
id	integer	true	The Branch id
name	string	false	Branch name
description	string	false	Branch description
agencyDefault	boolean	false	If the branch is the agency default branch
active	boolean	false	If the branch is active
readOnly	boolean	false	If the branch is read only

Input

Parameters

=> integer Required

=> string Optional

=> boolean Optional

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

Show/hide List Operations Expand Operations

Candidate

GET /apiC/1.0/candidate.json stable

Gets the candidate information.

Documentation
Request
Response
Sandbox

Documentation

Gets the candidate information.

Geosearch: lat, lng and radius are mandatory. It will get back a set of candidate inside the circle with centre (lat, lng) and radius.

Status Codes

Status Code	Description
200	Returned when successful
300	No entity validated
350	No action validated
400	No parameters validated

Parameters

Parameter	Type	Required	Operators	Example	Description
ids	integer	false	multi		id/ids(comma separated)
email	string	false	eq		Candidate email address
name	string	false	LIKE,eq		Candidate name
pRate	integer	false	=,<,>,<=,>=		Candidate pRate
lat	double	false			Latitude
lon	double	false			Longitude
radius	double	false	<		Radius from lat/long point in miles/km.
modifiedAfter	datetime	false		YYYY-MM-DD HH:mm:ss	Entities created or modified after specific date time (in UTC)
orderBy	integer	false	id,name,pRate,createdOn		OrderBy
page	integer	false			Offset or initial page index to retrieve entites. First element will be: page * limit
limit	integer	false			Total of entities to retrieve

Return

Parameter

Type

Description

code

integer

Status code of the request

data

collection

Result of the query

data (collection : Result of the query)

Parameter

Type

Description

count

integer

Number of results

results

Candidate[]

Array of candidates from the given filter

results (Candidate[] : Array of candidates from the given filter)

Parameter

Type

Description

status

string

Candidate availability

first_name

string

Candidate first name

middle_name

string

Candidate middle name

last_name

string

Candidate last name

username

string

Candidate username

DOB

date

Date of birth

facebook

string

Candidate Facebook account

twitter

string

Candidate Twitter account

string

Candidate LinkedIn account

skype

string

Candidate Skype account

customAttributes (Attribute[] : Candidate custom attributes)

Parameter	Type	Description
attr	integer	Attribute ID
value	string	Attribute value
text	integer	Attribute text
id	integer	ID
candidate	integer	Candidate ID
name	integer	Attribute name
entityID	integer	Entity ID
listID	integer	List ID

integrations_refs

integer[]

Bank IBAN

files

string

Bank IBAN

owner

string

Bank IBAN

candidate_id

string

Bank IBAN

user_id

string

Bank IBAN

social_number

string

Bank IBAN

phone_extension

string

Bank IBAN

address

string

Bank IBAN

country

string

Bank IBAN

county

string

Bank IBAN

city

string

Bank IBAN

address1

string

Bank IBAN

address2

string

Bank IBAN

postalCode

string

Bank IBAN

limitedAddress

string

Bank IBAN

timezone

string

Bank IBAN

ivr_id

string

Bank IBAN

pay_rate

string

Bank IBAN

external_id

string

Bank IBAN

base_lng

string

Bank IBAN

base_lat

string

Bank IBAN

last_lng

string

Bank IBAN

last_lat

string

Bank IBAN

worker_id

string

Bank IBAN

punctuality_max

string

Bank IBAN

punctuality_min

string

Bank IBAN

abilities_max

string

Bank IBAN

abilities_min

string

Bank IBAN

teamwork_max

string

Bank IBAN

teamwork_min

string

Bank IBAN

communication_max

string

Bank IBAN

communication_min

string

Bank IBAN

name

string

Bank IBAN

string

Bank IBAN

phone

string

Bank IBAN

jobTypes

JobType[]

Candidate Job Types

jobTypes (JobType[] : Candidate Job Types)

Parameter	Type	Description
internalID	integer	Internal Job Type ID
externalID	string	External Job Type ID
value	string	Job Type name/value
enabled	boolean	Enabled

Input

Parameters

=> multi integer Optional

=> eq string Optional

=> string Optional

=> integer Optional

=> double Optional

=> < double Optional

=> datetime Optional

=> integer Optional

Order By

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

DELETE /apiC/1.0/candidate/delete.json stable

Delete a candidate

Documentation
Request
Response
Sandbox

Documentation

[DELETE]/candidate/delete.json: Delete a candidate.

Status Codes

Status Code	Description
200	Returned when successful
300	No entity validated
350	No action validated
400	No parameters validated

Parameters

Parameter	Type	Required	Operators	Example	Description
id	integer	true			Candidate id

Return

Parameter

Type

Description

code

integer

Status code of the request

data

collection

Result of the query

data (collection : Result of the query)

Parameter	Type	Description
status	string	Candidate status

Input

Parameters

=> integer Required

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /apiC/1.0/candidate/post.json stable

Insert a candidate

Documentation
Request
Response
Sandbox

Documentation

[POST]/candidate/post.json: Insert a candidate.

Insert a new candidate in TempBuddy. If some of [country, postalCode, county, city, address2, address1] is used, then the field address will be overwriten by the concatenation of the previous fields. The name field is going to be replaced by first_name, middle_name and last_name fields.

Status Codes

Status Code	Description
200	Returned when successful
300	No entity validated
350	No action validated
400	No parameters validated

Parameters

Parameter	Type	Required	Example	Description
username	string	false		Username. If not provided, an automaticatilly generated username will be used.
email	string	true		Email
name	string	false		Full Name. It's strongly recommended to use separated fields of the name, since in the next versions this field will be removed.
first_name	string	true		First Name
middle_name	string	false		Middle Name
last_name	string	false		Last Name
jobTypes[]	string	false	{'externalId': 1, 'value': 'Nursery'}	Candidate Job Types
phone	string	true	+ XXX YYY YYYYYY	Main phone number. Number should be international.
address	string	false		Complete address [address2, address1, city, county, postalCode, country]. It's strongly recommended to use separated fields of the address, since in the next versions this field will be removed.
postalCode	string	false		ZIP / Postal Code
country	string	false		Country (Complete name or ISO code)
county	string	false		State / Province / County / Region
city	string	false		City / Town / District
address2	string	false		Street name and number
address1	string	false		Floor / Apt / Unit
categories	[string]	true	["Engineer"]	Category. Only one category can be sent in the array. If both are used the categoryIds takes preference over the categories. One of them is required.
categoryIds	[string]	false	[1]	Category id. Only one category id can be sent in the array. If both are used the categoryIds takes preference over the categories. One of them is required.
password	string	false		password
status	string	false	unavailable	Status. Only 'unavailable' status or having an expiryDate in the past, will prevent the user from being matched with jobs.
expiryDate	datetime	false	2020-01-01 00:00:00	Datetime when the candidate stops being 'available' (UTC).
dob	date	false		Date of Birth
ssn	string	false		Social Security Number (SSN, NI or similar)
facebook	string	false		URL to facebook profile
twitter	string	false		URL to twitter profile
linkedin	string	false		URL to linkedin profile
skype	string	false		Skype username
pRate	double	false		Default pay rate
tagValues	[string]	false	["tag1", "tag2", ...]	array of tag values
tag_ids	[string]	false	["tag1", "tag2", ...]	array of tag ids
attributes	array	false	[[attribute_id, "attribute_value", attribute_list_id, attribute_value_id], [...]]	Custom Attributes to set up, it is an array of pairs attribute_id, "value". In case attribute type is a list the attribute value id has to be sent as value.
externalRef	string	false		External Ref
ownerId	integer	false		User id of the owner. If both (ownerId and externalOwnerId) are used the ownerId takes preference over the externalOwnerId.
owner[id]	integer	false		Owner ID
owner[type]	string	false		Owner type
externalOwnerId	string	false		External user ID of the owner. If both (ownerId and externalOwnerId) are used the ownerId takes preference over the externalOwnerId.
branchId	integer	false		Branch id
usernameHint	boolean	false		When it is TRUE instead of an error (default behaviour), the candidate is created even when the provided username is already taken by any other user, but the username value is slightly changed making it unique.

Return

Parameter	Type	Description
code	integer	Status code of the request
data	integer	Candidate ID

Input

Parameters

=> string Optional

=> string Required

=> string Optional

=> string Required

=> string Optional

=> string Required

=> string Optional

=> [string] Required

=> [string] Optional

=> string Optional

=> datetime Optional

=> date Optional

=> string Optional

=> double Optional

=> [string] Optional

=> array Optional

=> string Optional

=> integer Optional

=> string Optional

=> integer Optional

=> boolean Optional

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /apiC/1.0/candidate/profilePicture stable

Gets candidate profile pictures. Max of 50 pictures at once.

Documentation
Request
Response
Sandbox

Documentation

[GET]/candidate/profilePicture: Gets candidate profile pictures.

Status Codes

Status Code	Description
200	Returned when successful
300	No entity validated
350	No action validated
400	No parameters validated

Parameters

Parameter	Type	Required	Operators	Example	Description
ids	integer	true	multi		Candidate Id
format	string	false			Format allowed: json, jpeg. In case of json, pictures are in base64. In case of jpeg, only one picture can be retrieved.

Return

Parameter

Type

Description

code

integer

Petition status code

data

collection

Result of the query

data (collection : Result of the query)

Parameter	Type	Description
[CANDIDATE_ID]	string	Picture

Input

Parameters

=> multi integer Required

=> string Optional

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

PUT /apiC/1.0/candidate/put.json stable

Update a candidate

Documentation
Request
Response
Sandbox

Documentation

Update a candidate. To change part of the location address, need to fill all split address fields. Empty address fields will be also updated.

Status Codes

Status Code	Description
200	Returned when successful
300	No entity validated
350	No action validated
400	No parameters validated

Parameters

Parameter	Type	Required	Example	Description
id	integer	true		Candidate id
email	string	false		Email
name	string	false		Full name It's strongly recommended to use separated fields of the name, since in the next versions this field will be removed.
first_name	string	false		First Name
middle_name	string	false		Middle Name
last_name	string	false		Last Name
jobTypes[]	string	false	{'externalId': 1, 'value': 'Nursery'}	Candidate Job Types
dob	date	false		Date of Birth
ssn	string	false		Social Security Number (SSN, NI or similar)
phone	string	false	+ XXX YYY YYYYYY	Main phone number. Number should be international.
address	string	false		Complete address [address1, address2, city, county, postalCode, country]. It's strongly recommended to use separated fields of the address, since in the next versions this field will be removed.
postalCode	string	false		ZIP / Postal Code
country	string	false		Country (Complete name or ISO code)
county	string	false		State / Province / County / Region
city	string	false		City / Town / District
address2	string	false		Street name and number
address1	string	false		Floor / Apt / Unit
status	string	false	unavailable	Status. Only 'unavailable' status or having an expiryDate in the past, will prevent the user from being matched with jobs.
expiryDate	datetime	false	2020-01-01 00:00:00	Datetime when the candidate stops being 'available' (UTC).
facebook	string	false		URL to facebook profile
twitter	string	false		URL to twitter profile
linkedIn	string	false		URL to linkedin profile
skype	string	false		Skype username
pRate	double	false		Default pay rate
externalRef	string	false		External Ref
tagValues	[string]	false	["tag1", "tag2", ...]	array of tag values. It will replace the current values.
tag_ids	[string]	false	["tag1", "tag2", ...]	array of tag ids
categories	[string]	false	["Engineer"]	Category. Only one category can be sent in the array. If both are used the categoryIds takes preference over the categories. One of them is required.
categoryIds	[string]	false	[1]	Category id. Only one category id can be sent in the array. If both are used the categoryIds takes preference over the categories. One of them is required.
branchId	integer	false		Branch id
addAttributes	array	false	[[attribute_id, attribute_value, attribute_list_id, attribute_value_id], [...]]	Custom Attributes to set up, it is an array of pairs 'attribute_id, value'. In case attribute type is a list the attribute value id has to be sent as value.
removeAttributes	array	false	[attribute_id_1, attribute_id_2, ...]	Custom Attributes ids to be removed
ownerId	integer	false		User id of the owner. If both (ownerId and externalOwnerId) are used the ownerId takes preference over the externalOwnerId.
owner[id]	integer	false		Owner ID
owner[type]	integer	false		Owner type
externalOwnerId	string	false		External user ID of the owner. If both (ownerId and externalOwnerId) are used the ownerId takes preference over the externalOwnerId.

Return

Parameter

Type

Description

code

integer

Petition status code

data

collection

Result of the query

data (collection : Result of the query)

Parameter	Type	Description
updated	boolean	Update success

Input

Parameters

=> integer Required

=> string Optional

=> date Optional

=> string Optional

=> datetime Optional

=> string Optional

=> double Optional

=> string Optional

=> [string] Optional

=> integer Optional

=> array Optional

=> integer Optional

=> string Optional

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

Show/hide List Operations Expand Operations

Client

GET /apiC/1.0/client.json stable

Gets the client information.

Documentation
Request
Response
Sandbox

Documentation

[GET]/client.json: Gets the client information.

Status Codes

Status Code	Description
200	Returned when successful
300	No entity validated
350	No action validated
400	No parameters validated

Parameters

Parameter	Type	Required	Operators	Example	Description
ids	integer	false	multi		client id
name	string	false	LIKE,eq		Client name
modifiedAfter	datetime	false		YYYY-MM-DD HH:mm:ss	Entities created or modified after specific date time (in UTC)
orderBy	integer	false	id,name		OrderBy
page	integer	false			Offset or initial page index to retrieve entites. First element will be: page * limit
limit	integer	false			Total of entities to retrieve

Return

Parameter

Type

Description

code

integer

Status code of the request

page

integer

Number of the page of paginated results

limit

integer

Limit of row per page result

data

collection

Result of the request

data (collection : Result of the request)

Parameter

Type

Description

count

integer

Number of results returned

results

Client[]

List of Clients

results (Client[] : List of Clients)

Parameter

Type

Description

integer

ID of the client

name

string

Name of the client

phone

string

Client's primary contact phone

phoneExt

string

Phone extension

addr

Address

Full address

sector

string

Sector name

externalRef

string

External reference of the client

created

Date

Date of creation

modified

Date

Date of last modiciation

customAttributes

array

Array of id of custom attributes associated to this client

integrations_refs

array

Array of integration refs related to this client

files

array

Array of files ID related with this client

owner

collection

Client's owner

owner (collection : Client's owner)

Parameter	Type	Description
id	integer	ID of the owner type
type	string	Type of owner (either RECRUITER or TEAM)

timesheetGeneration

integer

Flag to indicate if this client has the timesheet generation functions enabled

timeCapture

integer

Flag to indicate if this client has time capture functions enabled

Input

Parameters

=> multi integer Optional

=> string Optional

=> datetime Optional

=> integer Optional

Order By

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

DELETE /apiC/1.0/client/contact/delete.json stable

Delete a client contact

Documentation
Request
Response
Sandbox

Documentation

Delete a client contact.

Status Codes

Status Code	Description
200	Returned when successful
300	No entity validated
350	No action validated
400	No parameters validated

Parameters

Parameter	Type	Required	Operators	Example	Description
id	integer	true			Contact Id to delete

Return

Parameter

Type

Description

code

integer

Status code of the request

data

collection

Response data of the endpoint

data (collection : Response data of the endpoint)

Parameter	Type	Description
result	boolean	Result of the query showed as true or false
message	string	Information message about the response

Input

Parameters

=> integer Required

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /apiC/1.0/client/contact/get.json stable

Get a client contact.

Documentation
Request
Response
Sandbox

Documentation

Get a client contact. They can be retrieve by client IDs or by specific contact IDs.

Status Codes

Status Code	Description
200	Returned when successful
300	No entity validated
350	No action validated
400	No parameters validated

Parameters

Parameter	Type	Required	Operators	Example	Description
clientID	integer	false	multi		Client Id
contactID	integer	false	multi		Contact Id
modifiedAfter	datetime	false		YYYY-MM-DD HH:mm:ss	Entities created or modified after specific date time (in UTC)

Return

Parameter

Type

Description

code

integer

Status code of the request

data

collection

Result of the query

data (collection : Result of the query)

Parameter

Type

Description

count

integer

Number of results

results

Contact[]

Array of contacts from the given client ID

results (Contact[] : Array of contacts from the given client ID)

Parameter

Type

Description

string

ID of the Contact

clientID

integer

ID of the related Client

name

string

Name of the Contact

last_name

string

Last name of te Contact

phone

string

Phone number of the Contact

phone1

string

Extra phone number of the Contact

phone2

string

Extra phone number of the Contact

phone3

string

Extra phone number of the Contact

phoneExt

string

position

string

Position of the Contact

company_position

string

Position of the Contact in the company

department

string

Department of the contact in the company

location

integer

Location of the Contact

location_UUID

string

UUID of the location in the global database

string

Email of the Contact

modified

Date

Date of the last modified of the Contact

created

Date

Date of creation of the Contact

customAttributes

CustomAttribute[]

List of custom attributes of the Contact

integrations_refs

Array[]

List of integration references

owner

collection

Client contact's owner

owner (collection : Client contact's owner)

Parameter	Type	Description
id	integer	Client contact owner ID. It is inherited from client
type	string	Owner type (RECRUITER or TEAM). It is inherited from client

Input

Parameters

=> multi integer Optional

=> datetime Optional

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /apiC/1.0/client/contact/post.json stable

Add a new contact to a client

Documentation
Request
Response
Sandbox

Documentation

Add a new contact to a client.

Status Codes

Status Code	Description
200	Returned when successful
300	No entity validated
350	No action validated
400	No parameters validated

Parameters

Parameter	Type	Required	Example	Description
clientID	integer	true		Client id
name	string	false		Contact Full Name. It's strongly recommended to use separated fields of the name, since in the next versions this field will be removed.
first_name	string	false		Contact name
middle_name	string	false		Contact name
last_name	string	false		Contact name
department	string	false		Department
company_position	string	false		Position in the company
email	string	true		Contact email
location_uuid	string	false		UUID to attach this contact to a specific location. Omit to assign to 'All Locations'
phone_extension	string	false		Phone extension
phone1	string	true		Main Contact Phone
phone2	string	false		Option Contact Phone 1
phone3	string	false		Optional Contact Phone 2
attributes	array	false	[[attribute_id, "attribute_value", attribute_list_id, attribute_value_id], [...]]	Custom Attributes to set up, it is an array of pairs 'attribute_id, value'. In case attribute type is a list the attribute value id has to be sent as value.

Return

Parameter

Type

Description

code

integer

Status code of the request

data

collection

Result of the query

data (collection : Result of the query)

Parameter

Type

Description

count

integer

Number of results

results

Contact[]

Array of contacts from the given client ID

results (Contact[] : Array of contacts from the given client ID)

Parameter	Type	Description
id	string	ID of the Contact
clientID	integer	ID of the related Client
name	string	Name of the Contact
last_name	string	Last name of te Contact
phone	string	Phone number of the Contact
phone1	string	Extra phone number of the Contact
phone2	string	Extra phone number of the Contact
phone3	string	Extra phone number of the Contact
phoneExt	string
position	string	Position of the Contact
company_position	string	Position of the Contact in the company
department	string	Department of the contact in the company
location	integer	Location of the Contact
location_UUID	string	UUID of the location in the global database
email	string	Email of the Contact
modified	Date	Date of the last modified of the Contact
created	Date	Date of creation of the Contact
customAttributes	CustomAttribute[]	List of custom attributes of the Contact
integrations_refs	Array[]	List of integration references

Input

Parameters

=> integer Required

=> string Optional

=> string Required

=> string Optional

=> string Required

=> string Optional

=> array Optional

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

PUT /apiC/1.0/client/contact/put.json stable

Edit a client contact

Documentation
Request
Response
Sandbox

Documentation

Edit a client contact.

Status Codes

Status Code	Description
200	Returned when successful
300	No entity validated
350	No action validated
400	No parameters validated

Parameters

Parameter	Type	Required	Example	Description
id	integer	true		Contact Id to edit
name	string	false		Contact Full Name. It's strongly recommended to use separated fields of the name, since in the next versions this field will be removed.
first_name	string	false		Contact name
middle_name	string	false		Contact name
last_name	string	false		Contact name
department	string	false		Department
company_position	string	false		Position in the company
email	string	false		Contact email
location_uuid	string	false		UUID to attach this contact to a specific location. Omit to assign to 'All Locations'
phone_extension	string	false		Phone extension
phone1	string	false		Main Contact Phone
phone2	string	false		Option Contact Phone 1
phone3	string	false		Optional Contact Phone 2
addAttributes	array	false	[[attribute_id, attribute_value, attribute_list_id, attribute_value_id], [attribute_id, attribute_value]]	Custom Attributes to set up, it is an array of pairs 'attribute_id, value'. In case attribute type is a list the attribute value id has to be sent as value.
removeAttributes	array	false	[attribute_id_1, attribute_id_2, ...]	Custom Attributes ids to be removed

Return

Parameter

Type

Description

code

integer

Status code of the request

data

collection

Result of the query

data (collection : Result of the query)

Parameter	Type	Description
updated	boolean	Result of the query showed as true or false

Input

Parameters

=> integer Required

=> string Optional

=> array Optional

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

DELETE /apiC/1.0/client/delete.json stable

Delete a client

Documentation
Request
Response
Sandbox

Documentation

Delete a client.

Status Codes

Status Code	Description
200	Returned when successful
300	No entity validated
350	No action validated
400	No parameters validated

Parameters

Parameter	Type	Required	Operators	Example	Description
id	integer	true			Client id

Return

Parameter

Type

Description

code

integer

Status code of the request

data

collection

Result of the query

data (collection : Result of the query)

Parameter	Type	Description
result	boolean	Result of the query showed as true or false
message	string	Information message about the response

Input

Parameters

=> integer Required

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

DELETE /apiC/1.0/client/location/delete.json stable

Delete a client location

Documentation
Request
Response
Sandbox

Documentation

[DELETE]/client/location/delete.json: Delete a client location.

Status Codes

Status Code	Description
200	Returned when successful
300	No entity validated
350	No action validated
400	No parameters validated

Parameters

Parameter	Type	Required	Operators	Example	Description
uuid	string	true			UUID of location

Return

Parameter	Type	Description
code	integer	Status code of the request
data	collection	Result of the query

Input

Parameters

=> string Required

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /apiC/1.0/client/location/get.json stable

Get a client location.

Documentation
Request
Response
Sandbox

Documentation

Get a client location. They can be retrieve by client IDs or by specific UUIDs.

Status Codes

Status Code	Description
200	Returned when successful
300	No entity validated
350	No action validated
400	No parameters validated

Parameters

Parameter	Type	Required	Operators	Example	Description
clientID	integer	false	multi		Client Id. Either this field or uuid are required.
uuid	string	false	multi		UUID of location. Either this field or clientID are required.
modifiedAfter	datetime	false		YYYY-MM-DD HH:mm:ss	Entities created or modified after specific date time (in UTC)

Return

Parameter

Type

Description

code

integer

Status code of the request

data

collection

Result of the query

data (collection : Result of the query)

Parameter

Type

Description

count

integer

Number of results

results

Contact[]

Array of contacts from the given client ID

results (Contact[] : Array of contacts from the given client ID)

Parameter	Type	Description
uuid	string	UUID of the global Location
label	integer	Label to identify the Location
lat	long	Latitude of the Location
lng	long	Longitude of the Location
address	string	Address of the Location
country	string	Country of the Location
county	string	County of the Location
city	string	City of the Location
address1	string	Address 1 of the Location
address2	string	Address 2 of the Location
postalCode	string	Postal code of the Location
limitedAddress	string	The union of Country and County
timezone	integer	Timezone accoding to the Location zone
ownerID	integer	ID of the owner of the Location
branchId	integer	ID of the branch of the Location
phone	Date	Phone number of the Location
created	Date	Create date of the Location
modified	CustomAttribute[]	Last date Location was modified
customAttributes	Array[]	List of custom attributes of the Location
integrations_refs	Array[]	List of integration references

Input

Parameters

=> multi integer Optional

=> multi string Optional

=> datetime Optional

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /apiC/1.0/client/location/post.json stable

Add a new location to a client.

Documentation
Request
Response
Sandbox

Documentation

[POST]/client/location/post.json: Add a new location to a client. If some of [country, postalCode, county, city, address2, address1] is used, then the field address will be overwriten by the concatenation of the previous fields.

Status Codes

Status Code	Description
200	Returned when successful
300	No entity validated
350	No action validated
400	No parameters validated

Parameters

Parameter	Type	Required	Description
clientID	integer	true	Client id
label	string	true	Label for the location
address	string	false	Complete address [address2, address1, city, county, postalCode, country]. It's strongly recommended to use separated fields of the address, since in the next versions this field will be removed.
postalCode	string	false	ZIP / Postal Code
country	string	false	Country (Complete name or ISO code)
county	string	false	State / Province / County / Region
city	string	false	City / Town / District
address2	string	false	Street name and number
address1	string	false	Floor / Apt / Unit
phones