Public API Reference (Beta)JobsSearch

Search Jobs

Runs a full-text and filter-based search across Jobs visible to the authenticated user. The request's `fields` list contains one entry per searchable field. Each field carries its own modifiers: - `required` — AND - `excluded` — NOT - optional exact-match, date and numeric ranges - nested OR-grouped sub-fields Pagination is controlled with `pageSize` and `startRecord`.

Authentication

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

Request

This endpoint expects an object.
fieldslist of objectsOptional

List of per-field criteria. An empty or omitted list returns all jobs visible to the authenticated user, subject to pagination.

pageSizeintegerOptional
Number of results to return per page. Defaults to 25 if omitted. Capped at 100 by the server.
startRecordintegerOptional

Zero-based offset of the first record to return. Use multiples of ‘pageSize’ to page through results.

orderBystringOptional

Name of the field to sort by. Defaults to ‘score’ (relevance) when omitted.

orderDirstringOptional

Sort direction: ‘asc’ or ‘desc’.

locationstringOptional

Geo-spatial centre point for radius searches (postal code or city/state).

radiusintegerOptional

Geo-spatial search radius in miles, applied around ‘location’.

searchChildCompaniesbooleanOptional
When true, also search jobs belonging to the authenticated user's managed child companies. The set of managed child companies is taken from the user's session.
searchDeletedbooleanOptional

When true, include soft-deleted jobs in the results.

returnFieldslist of stringsOptional

Optional list of additional field names to populate on each hit, on top of the default set that is always returned. Field names must come from the catalog returned by GET /api/v1/jobs/search/fields and only entries flagged returnable=true in that catalog can be projected — fields with returnable=false are searchable but not stored, so listing them here has no effect on the response. The default set (always returned, regardless of this parameter) is: score, req_gk, guid, company_gk, client_guid, client_office_guid, client_contact_guid, company_name, client_contact_last_name, client_contact_first_name, client_contact_name, location_city, location_state_abbr, job_title, status_id, security_client_contact_approver_gk, security_client_contact_access_gk, security_client_workgroup_gk, create_user_guid, client_office_name, client_office_gk, min_bill_rate, min_bill_type_name, max_bill_rate, max_bill_type_name. When ‘searchChildCompanies’ is true, ‘company_name’ is also included by default. Use this parameter to pull in extra fields such as additional job attributes or UDFs.

Response

Search results returned