API Field Directory — CandidatesFields available via the API for Candidate records, with required formatting.
Field Name
Format
Example
Description
UserId *
String
"USER_10"
The Colleague 7 User ID (mandatory)
Forenames
String
"John"
The forenames of the Candidate
Surname
String
"Smith"
The surname of the Candidate
KnownAs
String
"John"
The Known As / Salutation field
Title
String/Lookup
"Mr" or lookup code
The lookup description or code of Title
DirectNumber
String
"01603 735930"
Direct telephone number of the Candidate
DirectFax
String
"01603 735935"
Direct fax number (if applicable)
MobileNumber
String
"07777 777777"
Mobile number of the Candidate
OtherNumber
String
"01603 735930"
Another relevant phone number
Website
String
"http://www.colleaguesoftware.com"
A website address specific to the Candidate
Gender
String/Lookup
"Male" or lookup code
Gender lookup description or code
Married
Boolean
"true"
Married flag
CandidateStatus
String/Lookup
"Active" or lookup code
Candidate Status lookup
CandidateType
String/Lookup
"Contract" or lookup code
Candidate Type lookup
CandidateSource
String/Lookup
"Referral" or lookup code
Candidate Source lookup
Nationality
String/Lookup
"British" or lookup code
Nationality lookup
JobType
String
"Project Manager"
Freetext preferred job titles
DateOfBirth
date-time (dd MMM yyyy)
"02 Jul 1981"
Candidate date of birth
DateAvailable
date-time (dd MMM yyyy)
"28 Jan 2020"
Next available date
CurrentSalary
int32
"30000"
The current salary
WantedSalary
int32
"35000"
The desired salary
CurrentPay
int32
"100"
The current pay rate
WantedPay
int32
"150"
The desired pay rate
NoticePeriod
int32
"4"
Notice period in weeks
SalaryBreakdown
String
"Company Car and Mobile Phone"
Freetext desired package
AddressLine1
String
"The Control Tower"
First line of address
AddressLine2
String
"Witchcraft Way"
Second line of address
AddressLine3
String
"Rackheath"
Third line of address
City
String
"Norwich"
Town of address
County
String
"Norfolk"
County of address
Postcode
String
"NR13 6GA"
Postcode of address
Country
String/Lookup
"United Kingdom" or lookup code
Country of address
TelephoneNumber
String
"01603 735930"
Home telephone number
FaxNumber
String
"01603 735935"
Home fax number
NoteTab
int32
"0"
Note tab to add notes to (0–4)
Notes
String
"Only Available via Mobile"
Generic notes against the Candidate
CurrencyCode
String/Lookup
"GBP" or lookup code
Currency lookup
PreviousJobTitles
String
"Account Manager, Project Manager"
Freetext previous job titles
CustomFields
Array
JSON array of { customFieldName, customFieldValue }
Custom fields to add to the Candidate
SkillsToAdd
Array
JSON array of { lookupCode, lookupParent, lookupPath }
Skills to add (lookupCode mandatory; parent & path optional)
Username
String
"John.Smith"
8–255 chars (optional if Password omitted)
Password
String
"ABC.Password"
8–255 chars (optional if Username omitted)
* Mandatory field.
|