API Field Directory - RequirementsFields available via the API for Requirement records, with required formatting.
Field Name
Format
Example
Description
UserId *
String
"USER_10"
The Colleague 7 User ID (mandatory)
CompanyName
String
"Colleague Software"
Search for Requirements belonging to any Companies containing this term
ContactName
String
"Will Minns"
Search for Requirements belonging to any Contacts containing this term
JobTitle
String
"Account Manager"
Search for Requirements containing this Job Title term
Status
String/Lookup
"Live" or lookup code
Search by Status, based on the Requirement Status (REQSTATUS) lookup
Type
int32
"0"
Search by type - -100: Any, 0: Contract, 1: Permanent, 2: Rolling Contract
PickedUpAfter
date-time
"20 JAN 1971"
RFC3339 date-time. Requirements picked up after (or on) this date/time
PickedUpBefore
date-time
"19 JAN 1971"
RFC3339 date-time. Requirements picked up before this date/time
RequirementID
int64
"123"
Fetch the Requirement matching this ID (all other criteria disregarded)
IdsOnly
Boolean
"False"
Fetch all details, or only the Requirement IDs (defaults to all details)
JobCode
String
null
Job code
Department
String
null
Department the Requirement is for
StatusCode
String
"Live"
Requirement Status code
StatusDescription
String
"Live"
Requirement Status lookup description
RequirementType
int32
"1"
Requirement type code
RequirementTypeDescription
String
"1"
Requirement type description
RequirementSource
String/Lookup
null
Requirement Source lookup
ReferenceNo
String
null
Reference number
EntityDescription
String
"Requirement for Sales Manager at Colleague Software with John Smith"
Summary description of the record
JobDescription
String (HTML)
HTML job description
Full job description
JobTitleAndDescription
String (HTML)
"Sales Manager" + HTML job description
Job title followed by the job description
Benefits
String
"Offers flexible and remote working"
Benefits package
CompanyId
int32
"1"
ID of the Company
ContactId
int32
"149"
ID of the Contact
ContactDeleted
Boolean (0/1)
"0"
Contact has been deleted
ContactArchived
Boolean (0/1)
"0"
Contact has been archived
ContactEmailAddress
String
"john.smith@colleaguesoftware.com"
Email address of the Contact
ContactTelephoneNumber
String
"01603 735930"
Telephone number of the Contact
MobileNumber
String
"07777 777777"
Mobile number of the Contact
AdditionalContacts
String
""
Additional Contacts linked to the Requirement
AdditionalContactsDetails
String
""
Details of the additional Contacts
Address
String
"The Control Tower, Witchcraft Way, Rackheath, Norwich, NR13 6GA"
Address of the Requirement
AddressId
int32
"2"
ID of the address
Town
String
"Norwich"
Town of address
Postcode
String
"NR13 6GA"
Postcode of address
Country
String/Lookup
"United Kingdom"
Country of address
DatePickedUp
date (dd MMM yyyy)
"21 May 2025"
Date the Requirement was picked up
PickedUpBy
String
"David Demo"
User who picked up the Requirement
PickedUpByUser
String
"David Demo"
User who picked up the Requirement
DateFilled
date (dd MMM yyyy)
null
Date the Requirement was filled
StartDate
date-time
"2024-12-01 00:00:00.000"
Start date of the role
StartDateNotes
String
"ASAP"
Notes about the start date
StartTime
String
null
Daily start time
EndTime
String
null
Daily end time
HoursPerWeek
Decimal
"37.0"
Hours per week
HoursPerDay
Decimal
"0.0"
Hours per day
HoursUOM
int32
"1"
Hours unit of measure
BreakEntitlement
Decimal
"0.0"
Break entitlement
ContractLength
int32
"36"
Contract length
ContractLengthUOM
int32
"1"
Contract length unit of measure
RenewalPeriod
int32
"0"
Renewal period
NoticePeriod
int32
"12"
Notice period
NoticePeriodUOM
int32
"1"
Notice period unit of measure
NoticePeriod2
int32
"0"
Second notice period
NoticePeriod2UOM
int32
"1"
Second notice period unit of measure
ExpMinSalary
Decimal
"50000.0"
Expected minimum salary
ExpMaxSalary
Decimal
"60000.0"
Expected maximum salary
ExpChargeRate
Decimal
"150.0"
Expected charge rate
ExpPayRate
Decimal
"125.0"
Expected pay rate
ExpChargeRatePAYE
Decimal
"0.0"
Expected PAYE charge rate
ExpPayRatePAYE
Decimal
"0.0"
Expected PAYE pay rate
ChargeUnit
int32
"3"
Charge unit code
CurrencyCode
String/Lookup
"GBP" or lookup code
Currency lookup
PotentialValue
Decimal
"204.55"
Potential value of the Requirement
IR35Status
String
null
IR35 status
NumberOfPlaces
int32
"999"
Number of places available
NumberOfPlacements
int32
"4"
Number of placements made
RequirementCandidateLonglistCount
int32
"16"
Number of longlisted Candidates
RequirementCandidateShortlistCount
int32
"12"
Number of shortlisted Candidates
RequirementCandidateSentCount
int32
"7"
Number of CVs sent
RequirementCandidateInterviewCount
int32
"6"
Number of interviews
RequirementCandidateOfferCount
int32
"6"
Number of offers
RequirementCandidatePlacementCount
int32
"6"
Number of placements
RequirementCandidateRejectedCount
int32
"3"
Number of rejected Candidates
RequirementCandidateRemovedCount
int32
"1"
Number of removed Candidates
RequirementCandidateMostRecentLonglist
date-time
"2026-09-28 10:43:23.890"
Date of the most recent longlist
RequirementCandidateMostRecentShortlist
date-time
"2026-09-28 10:44:01.403"
Date of the most recent shortlist
RequirementCandidateMostRecentSend
date-time
"2026-06-05 11:44:07.633"
Date of the most recent CV send
RequirementCandidateMostRecentInterview
date-time
"2026-06-12 13:00:00.000"
Date of the most recent interview
RequirementCandidateMostRecentOffer
date-time
"2026-06-05 11:47:50.223"
Date of the most recent offer
RequirementCandidateMostRecentPlacement
date-time
"2026-06-05 11:48:00.000"
Date of the most recent placement
RequirementCandidateMostRecentRejection
date-time
"2026-09-28 10:45:38.117"
Date of the most recent rejection
RequirementCandidateMostRecentRemoval
date-time
"2026-09-28 10:44:33.740"
Date of the most recent removal
MostRecentPlacementId
int32
"1114"
ID of the most recent placement
MostRecentPlacementType
int32
"0"
Type of the most recent placement
Posted
Boolean (0/1)
"0"
Requirement has been posted
PostedBy
String
""
User who posted the Requirement
PostedDate
date-time
null
Date the Requirement was posted
PostedToPublic
Boolean (0/1)
"0"
Requirement has been posted publicly
PublicPostedDate
date-time
null
Date the Requirement was posted publicly
SkillCount
int32
"11"
Number of skills held against the Requirement
UseRetainers
Boolean (0/1)
"0"
Retainers are used
RequirementTemplateId
int32
"0"
ID of the Requirement template
OwningCompanyId
int32
"0"
ID of the owning company
LeadId
int32
"0"
ID of the linked Lead
LeadTitle
String
null
Title of the linked Lead
InvoiceAccountReference
String
"ACCREF5566"
Invoice account reference
InvoiceAddressId
int32
"6857"
ID of the invoice address
InvoiceCompanyId
int32
"1"
ID of the invoice Company
InvoiceCompanyName
String
"Colleague Software Ltd"
Name of the invoice Company
InvoiceCompanyNumber
String
"CSL12345"
Registration number of the invoice Company
InvoiceContactId
int32
"149"
ID of the invoice Contact
InvoiceContactTitle
String
"Mr"
Title of the invoice Contact
InvoiceContactForenames
String
"John"
Forenames of the invoice Contact
InvoiceContactSurname
String
"Smith"
Surname of the invoice Contact
InvoiceTaxCode
String
"20"
Invoice tax code
InvoiceVatNumber
String
"GB 123 45 6"
Invoice VAT number
AdditionalInvoiceContacts
String
""
Additional Contacts that receive invoices
OwnedBy
String
"David Demo, Management Team"
Users who own the record
DateCreated
date-time
"2025-05-21 10:46:00.670"
Date the record was created
CreatedBy
String
"David Demo"
User who created the record
DateAmended
date-time
"2026-09-28 10:18:00.000"
Date the record was last amended
AmendedBy
String
"David Demo"
User who last amended the record
NoteId
int32
"3804"
ID of the notes held against the record
AlertText
String
""
Alert text shown on the record
AuthorisationLevel
int32
"0"
Authorisation level
* Mandatory field.
|