Search...
/
Get Support
Get a demo
Get Started
Welcome
Quickstart
Webhooks
Introduction
Creating a Webhook
Available Webhooks
API Reference
Applicants/Candidates
Jobs
Core
DEL
Delete Requirement
POST
Find Public Requirements By Query
GET
Find Requirement
GET
Find Requirement By Id
POST
Find Requirements By Query
POST
Get Rate Card
POST
Persist a Requirement
Notes
Attachments
Folders
Templates
Clients/Departments
Contacts/Managers
Office/Location
Activities
Submittals
Company
Employees
Job Boards
Folders
Reference Data
RPO
Users
Webhooks
Get Support
Get a demo
API Reference
Jobs
Core
Find Requirement By Id
GET
https://app.brightmove.com/ATS
/
app
/
req
/
get
/
:reqGk
Finds a Requirement by its id
Path parameters
reqGk
long
Required
Headers
X-Brightmove-User-ApiKey
string
Required
Response
OK
reqGk
long
Optional
copyFromReqGk
long
Optional
guid
string
Optional
reqNumber
string
Optional
jobTitle
string
Optional
templateName
string
Optional
openDate
datetime
Optional
endDate
datetime
Optional
duration
string
Optional
location
string
Optional
locationCity
string
Optional
locationState
object
Optional
Show 4 properties
locationPostalCode
string
Optional
requiredSkills
string
Optional
optionalSkills
string
Optional
publicDescription
string
Optional
privateDescription
string
Optional
reqStatus
object
Optional
Show 3 properties
minBillType
object
Optional
Show 2 properties
maxBillType
object
Optional
Show 2 properties
minBillRate
double
Optional
maxBillRate
double
Optional
minPayType
object
Optional
Show 2 properties
maxPayType
object
Optional
Show 2 properties
minPayRate
double
Optional
maxPayRate
double
Optional
bonusPct
double
Optional
bonusFlat
double
Optional
bonusNotes
string
Optional
openings
integer
Optional
originalOpenings
integer
Optional
createDate
datetime
Optional
createUserGk
long
Optional
createUserTypeId
integer
Optional
createUser
string
Optional
createUserGuid
string
Optional
modifyDate
datetime
Optional
modifyUserGk
long
Optional
modifyUser
string
Optional
modifyUserGuid
string
Optional
modifyUserTypeId
integer
Optional
placementType
object
Optional
Show 2 properties
approvalStatus
object
Optional
Show 2 properties
approver
object
Optional
Show 36 properties
jobGroup
object
Optional
Show 2 properties
clientJobId
string
Optional
statusComment
string
Optional
reqDuration
string
Optional
reqCategories
string
Optional
reqCategoryId
list of integers
Optional
feePct
double
Optional
feeAmt
double
Optional
pctChanceClose
double
Optional
postToInternal
boolean
Optional
postToWeb
boolean
Optional
syncDescription
boolean
Optional
reqLocations
list of objects
Optional
Show 10 properties
reqExams
list of longs
Optional
clientContact
object
Optional
Show 70 properties
contactName
string
Optional
clientContactGk
long
Optional
clientContactGuid
string
Optional
client
object
Optional
The Client object to save.
Show 38 properties
clientOfficeGk
long
Optional
clientOfficeName
string
Optional
clientOffice
object
Optional
Show 23 properties
clientGk
long
Optional
clientGuid
string
Optional
clientOfficeGuid
string
Optional
clientName
string
Optional
clientWebsite
string
Optional
reqCategory
object
Optional
Show 2 properties
statusId
integer
Optional
template
boolean
Optional
workFromHome
boolean
Optional
workRemote
boolean
Optional
workHybrid
boolean
Optional
editable
boolean
Optional
claimed
boolean
Optional
numSubmittals
integer
Optional
hasContactAccess
boolean
Optional
lineItemGuid
string
Optional
userCanApprove
boolean
Optional
portalGk
long
Optional
portalName
string
Optional
partTime
boolean
Optional
openGraphImage
string
Optional
productPayPlan
object
Optional
Show 20 properties
interviewSchedule
object
Optional
Show 23 properties
reqRecruiterList
list of strings
Optional
workgroupList
list of objects
Optional
Show 11 properties
jobCategoryList
list of integers
Optional
jobIndustryList
list of integers
Optional
jobFunctionList
list of integers
Optional
udfSections
list of objects
Optional
Show 6 properties
jobBoards
list of objects
Optional
Show 32 properties
recruiters
list of objects
Optional
Show 36 properties
claimUsers
list of objects
Optional
Show 61 properties
tags
list of objects
Optional
Show 4 properties
salesUser
object
Optional
Show 2 properties
sourcers
list of objects
Optional
Show 36 properties
workgroups
list of objects
Optional
Show 2 properties
vendors
list of objects
Optional
Show 2 properties
categories
list of objects
Optional
Show 2 properties
functions
list of objects
Optional
Show 2 properties
industries
list of objects
Optional
Show 2 properties
maxOte
double
Optional
minOte
double
Optional
Find Requirements By Query
Up Next
Built with