Search jobs

GET

/api/nova/jobs/search

Searches jobs in the account using a case-insensitive contains match on the query parameter against the job title, job reference, and the linked company and contact names and references. Query parameters are apiKey (required), query (the search text, empty by default), and page and size for the response metadata; size is capped at 100. The response contains the matching jobs with page, size and total count. Returns 401 for an invalid API key and 500 with an error message if the search fails.

Authorizations

privateApiKey

Type

API Key (query: apiKey)

Parameters

Query Parameters

apiKey*

apiKey

Type

string

Required

page

page

Type

integer

Format

"int32"

Default

0

query

query

Type

string

size

size

Type

integer

Format

"int32"

Default

20

Responses

OK

Content-Type

application/json

{

  

"data": [

  

  

{

  

  

  

"closingDate": "string",

  

  

  

"companyId": "string",

  

  

  

"companyName": "string",

  

  

  

"contactId": "string",

  

  

  

"contactName": "string",

  

  

  

"createdOn": "string",

  

  

  

"customFields": [

  

  

  

  

{

  

  

  

  

  

"boolValue": "string",

  

  

  

  

  

"dateValue": "string",

  

  

  

  

  

"fieldId": "string",

  

  

  

  

  

"fieldLabel": "string",

  

  

  

  

  

"listValue": [

  

  

  

  

  

  

"string"

  

  

  

  

  

],

  

  

  

  

  

"value": "string"

  

  

  

  

}

  

  

  

],

  

  

  

"dateOpened": "string",

  

  

  

"employmentTypeId": "string",

  

  

  

"employmentTypeName": "string",

  

  

  

"experienceLevelId": "string",

  

  

  

"experienceLevelName": "string",

  

  

  

"flexiHours": true,

  

  

  

"hot": true,

  

  

  

"id": "string",

  

  

  

"internalDescription": "string",

  

  

  

"lastActivityDate": "string",

  

  

  

"location": "string",

  

  

  

"maxPay": 0,

  

  

  

"minPay": 0,

  

  

  

"openPositions": 0,

  

  

  

"ownerId": "string",

  

  

  

"ownerName": "string",

  

  

  

"payCurrency": "string",

  

  

  

"payTenure": "string",

  

  

  

"rating": 0,

  

  

  

"reference": "string",

  

  

  

"relocation": true,

  

  

  

"remoteWorking": true,

  

  

  

"shortDescription": "string",

  

  

  

"skills": [

  

  

  

  

"string"

  

  

  

],

  

  

  

"sourceId": "string",

  

  

  

"sourceName": "string",

  

  

  

"startDate": "string",

  

  

  

"statusId": "string",

  

  

  

"statusName": "string",

  

  

  

"statusReason": "string",

  

  

  

"tags": [

  

  

  

  

{

  

  

  

  

  

"group": "string",

  

  

  

  

  

"value": "string"

  

  

  

  

}

  

  

  

],

  

  

  

"title": "string",

  

  

  

"updatedOn": "string",

  

  

  

"visaSponsored": true

  

  

}

  

],

  

"error": "string",

  

"message": "string",

  

"page": 0,

  

"requestId": "string",

  

"size": 0,

  

"success": true,

  

"total": 0

}

GET

/api/nova/jobs/search

Playground

Authorization

privateApiKey

Variables

Key

Value

apiKey*

page

query

size

Samples