API Field Directory - ContactsFields available via the API for Contact records, with required formatting.
Field Name
Format
Example
Description
UserId *
String
"USER_10"
The Colleague 7 User ID (mandatory)
ContactId
int32
"149"
Unique ID of the Contact record
Forenames *
String
"John"
The forenames of the Contact
Surname *
String
"Smith"
The surname of the Contact
Name
String
"John Smith"
Display name
FullName
String
"John Smith"
Forenames and surname
Searchname
String
"Smith-John"
Surname-forename search key
KnownAs
String
"John"
The Known As / Salutation field
Title
String/Lookup
"Mr" or lookup code
The lookup description or code of Title
TitleDescription
String
"Mr"
Title lookup description
Gender
String/Lookup
"Male" or lookup code
Gender lookup description or code
EntityDescription
String
"John Smith at Colleague Software"
Summary description of the record
CompanyId
int32
"1"
ID of the Company the Contact works for
CompanyName
String
"Colleague Software"
Name of the Company the Contact works for
CompanyWebsiteAddress
String
"http://www.colleaguesoftware.com"
Website address of the Company
JobTitle
String
"Product Owner"
Job title of the Contact
Department
String
"Development"
Department of the Contact
ContactType
String/Lookup
"Client" or lookup code
Contact Type lookup
ReportsTo
String
"Will Minns"
Contact this Contact reports to
ReportsToId
int32
"160"
ID of the Contact this Contact reports to
Assistant
String
"Jane Doe"
Assistant of the Contact
AssistantId
int32
"207"
ID of the assistant Contact record
ParentContactId
int32
"149"
ID of the parent Contact record
CandidateId
int32
"491"
ID of the linked Candidate record
StartDate
date (dd MMM yyyy)
"17 Feb 2026"
Date the Contact started at the Company
EndDate
date (dd MMM yyyy)
null
Date the Contact left the Company
DirectNumber
String
"01603 735930"
Direct telephone number of the Contact
DirectFax
String
null
Direct fax number (if applicable)
MobileNumber
String
"07777 777777"
Mobile number of the Contact
FormattedMobileNumber
String
"+447777777777"
Mobile number in international format
FormatedMobileNumber
String
"+447777777777"
Duplicate of FormattedMobileNumber
OtherNumber
String
null
Another relevant phone number
TelephoneNumber
String
"01603 735930"
Telephone number of the address
FaxNumber
String
null
Fax number of the address
ContactNumber
String
"01603 735930"
Main contact number
FullNumbers
String
"~07777777777~01603735930~"
Phone numbers and their variants, tilde separated
AllNumbers
String
"~07777777777~01603735930~"
All phone numbers, tilde separated
EmailAddress
String
"john.smith@colleaguesoftware.com"
Email address of the Contact
EmailAddress2
String
""
Secondary email address
Email
String
"john.smith@colleaguesoftware.com"
All email addresses, space separated
AllEmailAddresses
String
"john.smith@colleaguesoftware.com"
All email addresses, space separated
MailshotStatus
String/Lookup
"Allow All"
Mailshot status
MailshotExpiry
date-time
null
Date the mailshot status expires
ConsentRequested
date-time
"2024-07-01 10:24:00.000"
Date GDPR consent was requested
ResponseReceived
date-time
"2024-07-01 10:26:00.000"
Date a GDPR consent response was received
ConsentGiven
Boolean (0/1)
"1"
GDPR consent has been given
GDPRConsentId
GUID
"b9252fea-ETC"
ID of the GDPR consent request
GDPRConsentUser
GUID
"5964f9d6-ETC"
User linked to the GDPR consent
OwnerId
int32
"1"
ID of the record owner
OwnedBy
String
"Ben Ryder, Brett Cole, John Smith"
Users who own the record
Ownership
String
"Ben Ryder, Brett Cole, John Smith"
Users who own the record
DateOwned
date (dd MMM yyyy)
null
Date the current ownership began
DateCreated
date-time
"2017-02-17 11:11:20.320"
Date the record was created
CreatedBy
String
"John Smith"
User who created the record
DateAmended
date-time
"2026-09-09 14:22:12.823"
Date the record was last amended
AmendedBy
String
"David Demo"
User who last amended the record
LastContacted
date (dd MMM yyyy)
"28 Sep 2026"
Date the Contact was last contacted
LastContactedBy
String
"David Demo"
User who last contacted the Contact
ArchivedDate
date-time
null
Date the record was archived
ArchivedBy
String
null
User who archived the record
DeletedDate
date-time
null
Date the record was deleted
DeletedBy
String
null
User who deleted the record
NoteId
int32
"3489"
ID of the notes held against the record
Alert
String
""
Alert flag text
AlertText
String
""
Alert text shown on the record
CompanyAlert
String
""
Alert flag text of the Company
CompanyAlertText
String
""
Alert text shown on the Company
AuthorisationLevel
int32
"0"
Authorisation level
CompanyAuthorisationLevel
int32
"0"
Authorisation level of the Company
LiveRequirements
int32
"46"
Number of live requirements
ForwardInterviews
int32
"0"
Number of upcoming interviews
RequirementCount
int32
"217"
Total number of requirements
InterviewCount
int32
"318"
Total number of interviews
PlacementCount
int32
"202"
Total number of placements
SkillCount
int32
"13"
Number of skills held against the Contact
MovedToCompany
String
""
Company the Contact moved to
MovedToCompanyId
int32
"0"
ID of the Company the Contact moved to
MovedToContact
String
""
Contact record created at the new Company
MovedToContactId
int32
"0"
ID of the Contact record at the new Company
PreviousCompany
String
""
Company the Contact previously worked for
PreviousCompanyId
int32
"0"
ID of the previous Company
PreviousContact
String
""
Contact record at the previous Company
PreviousContactId
int32
"0"
ID of the Contact record at the previous Company
Address
String
"The Control Tower Witchcraft Way Rackheath Norwich NR13 6GA"
Address as a single line
AddressId
int32
"2"
ID of the address
AddressType
int32
"1"
Address type code
AddressDesc
String
"Head Office"
Address description
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
PostcodePrefix
String
"NR136GA"
Postcode with spaces removed
Country
String/Lookup
"United Kingdom" or lookup code
Country of address
CountryDescription
String
"United Kingdom"
Country lookup description
PrimaryFlag
Boolean (0/1)
"0"
Address is the primary address
InvoiceAddress
Boolean (0/1)
"0"
Address is an invoice address
AddressDateCreated
date-time
"2009-05-19 13:32:00.940"
Date the address was created
AddressCreatedBy
String
"DemoConsultant"
User who created the address
AddressDateAmended
date-time
"2025-03-14 12:06:54.513"
Date the address was last amended
AddressAmendedBy
String
"David Demo"
User who last amended the address
AddressTaxCode
String
"T1"
Tax code held against the address
VatNumber
String
"GB 123 45 6"
VAT number
CreditLimit
Decimal
"0.0"
Credit limit
InsuredCreditLimit
Decimal
"0.0"
Insured credit limit
AccountReference
String
"ACCREF5566"
Account reference
SecondaryAddressIds
String
",2674,7048,7058,"
IDs of secondary addresses, comma separated
AllAddresses
String
"The Control Tower Witchcraft Way... | Unit 3D..."
All addresses, pipe separated
AddressLink
String
HTML link to Google Maps
Link to view the address location
PortalActiveUser
Boolean (0/1)
"1"
Contact is an active Portal user
PortalEmailAddress
String
"john.smith@colleaguesoftware.com"
Portal sign-in email address
PortalPIN
String
"123456"
Portal PIN
PortalUserId
String
"USER_66"
Portal user ID
ImportedRecord
Boolean (0/1)
"0"
Record was created by an import
IsMerged
Boolean (0/1)
"0"
Record has been merged
FullContactXML
String
null
FullContact enrichment data
FullContactXMLLastUpdatedDate
date-time
null
Date the FullContact data was last updated
WhatExContactId
GUID
"0d356e4b-ETC"
WhatEx contact ID
* Mandatory field.
|