Public API Reference (Beta)JobsCore

Create a requirement

Authentication

X-Brightmove-Company-ApiKeystring
BrightMove Company Api Key
X-Brightmove-User-ApiKeystring
BrightMove User Api Key

Request

This endpoint expects an object.
jobTitlestringRequired
Job title for the open position.
clientGuidstringRequired

GUID of the client (company) this job opening is for.

clientOfficeGuidstringRequired
GUID of the client office location where this position is based.
clientContactGuidstringRequired

GUID of the client contact (hiring manager) for this position.

publicDescriptionstringOptional
Job description visible to candidates on public job boards.
privateDescriptionstringOptional
Internal notes about the position, visible only to recruiters.
requiredSkillsstringOptional
Skills that candidates must have to be considered for this position.
optionalSkillsstringOptional

Skills that are nice-to-have but not mandatory.

locationstringOptional

Free-text location description shown on job postings.

locationAddressstringOptional
Street address of the work location.
locationCitystringOptional
City of the work location.
locationStateIdlongOptional

State ID of the work location from the BrightMove state lookup. Use GET /api/v1/lookup/states to retrieve valid IDs.

locationPostalCodestringOptional

Postal (ZIP) code of the work location.

minBillRatedoubleOptional

Minimum bill rate charged to the client (per hour).

maxBillRatedoubleOptional

Maximum bill rate charged to the client (per hour).

minPayRatedoubleOptional

Minimum pay rate offered to the candidate (per hour).

maxPayRatedoubleOptional

Maximum pay rate offered to the candidate (per hour).

openingsintegerOptional
Number of open positions to fill. Defaults to 1 if not provided.
postToInternalbooleanOptional
When true, posts this job to your company's internal job board.
postToWebbooleanOptional

When true, posts this job to external/public job boards.

Response

Created