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)
