Search candidates

GET

/api/nova/candidates/search

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

JSON

{

"data": [

{

"alternateEmail": "string",

"createdOn": "string",

"currentEmployer": "string",

"customFields": [

{

"boolValue": "string",

"dateValue": "string",

"fieldId": "string",

"fieldLabel": "string",

"listValue": [

"string"

],

"value": "string"

}

],

"dateOfBirth": "string",

"doNotContact": true,

"educationHistory": [

{

"endYear": 0,

"grade": "string",

"id": "string",

"level": "string",

"major": "string",

"organisation": "string",

"startYear": 0

}

],

"email": "string",

"employmentHistory": [

{

"companyName": "string",

"employmentType": "string",

"endDate": "string",

"id": "string",

"jobTitle": "string",

"startDate": "string",

"workSummary": "string"

}

],

"facebook": "string",

"firstName": "string",

"hasCv": true,

"homePhone": "string",

"id": "string",

"inPipeline": true,

"internalNotes": "string",

"jobTitle": "string",

"lastActivityDate": "string",

"lastName": "string",

"linkedIn": "string",

"location": "string",

"mobile": "string",

"overview": "string",

"ownerId": "string",

"ownerName": "string",

"placed": true,

"rating": 0,

"reference": "string",

"rightToWork": true,

"skills": [

"string"

],

"sourceId": "string",

"sourceName": "string",

"statusId": "string",

"statusName": "string",

"tags": [

{

"group": "string",

"value": "string"

}

],

"twitter": "string",

"updatedOn": "string",

"workPermit": true,

"workPhone": "string"

}

],

"error": "string",

"message": "string",

"page": 0,

"size": 0,

"success": true,

"total": 0

}

GET

/api/nova/candidates/search

Playground

Variables

Key

Value

apiKey*

page

query

size

Samples