Appearance
Search candidates
GET
/api/nova/candidates/search
Runs a paged keyword search over the candidates in your account. The optional query parameter matches against candidate data, while page (default 0) and size (default 20, maximum 100) control pagination; results are sorted by creation date, newest first. Pass the optional savedSearchId parameter (from GET /api/nova/candidates/savedsearches) to return only the candidates matching that saved search's criteria — tags, custom fields, statuses, or any other filter saved in Recruitly; query then searches within the saved search's results. Returns a list of candidate records plus paging metadata and the total match count. Responds with 401 for an invalid API key and 429 when the account's read rate limit is exceeded.
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Query Parameters
apiKey*
apiKey
Type
Requiredstring
page
page
Type
integer
Format
"int32"Default
0query
query
Type
string
savedSearchId
savedSearchId
Type
string
size
size
Type
integer
Format
"int32"Default
20Responses
OK
application/json
JSON "data": [ { "address": { "city": "string", "country": "string", "postcode": "string", "state": "string", "street": "string" }, "alternateEmail": "string", "createdOn": "string", "currentEmployer": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "dateOfBirth": "string", "desiredSalary": 0, "desiredSalaryCurrency": "string", "desiredSalaryTenure": "string", "doNotContact": true, "educationHistory": [ { "endMonth": 0, "endYear": 0, "grade": "string", "id": "string", "level": "string", "major": "string", "organisation": "string", "startMonth": 0, "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", "languages": [ { "code": "string", "level": "string", "name": "string" } ], "lastActivityDate": "string", "lastName": "string", "linkedIn": "string", "location": "string", "mobile": "string", "noticePeriod": "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, "requestId": "string", "size": 0, "success": true, "total": 0
{
}