Resume API Documentation | Building your First Search Request

Building your First Search Request

Getting started with the new Candidate Search API requires you to pull information from several different sources. The table below describes the main list of search parameters.

Parameters are optional and can be omitted. The same way, some parameters have default values. That means if there are no values for some parameters in the search request, service will use default values.

Joining of Search Parameters

Request must include a valid authorization token in the Authorization header, formatted as: Authorization: Bearer {access_token} For detailed instructions on obtaining the token, please refer to this page.

To perform a Search Resume Request to production, send an authorised HTTPS GET request

GET https://candidate-search-api.efinancialcareers.com/api-search?{searchparameters}

The same request to pilot is the following:

GEThttps://candidate-search-api.pilotaws.efinancialcareers.com/api-search?%20{search%20parameters}

You can combine multiple search parameters in a single request using the & symbol.

For example:

keyword=Java&page=1&pageSize=10.

To apply multiple values to a single filter, use the pipe symbol (|).

For example:

filters.locationId=3865483|3577279

Some filters follow specific formatting patterns:

Filter

Format

Example

filters.sectors

sector/subsector

ASSET_MANAGEMENT/SALES_CLIENT_SERVICES|CAPITAL_MARKETS

filters.languageLe

vels

language/languageLevel

EN/COMPETENT|ES/BASIC

filters.seniority

seniority/seniorityLevel

DIRECTOR|CSVP_HEAD_OF/FIRST_VICE_PRESIDENT

Search Parameters

Valid values of search parameters can be received with the help of Dictionary Service (should be link to the new Retrieving Dictionary Values Page).

There is a list of default parameters below. They will be applied to the request by default if you don’t specify any of them in the request:

page = 1;

page-size = 10;

language = “en”;

matchMode = BOOLEAN;

Name

Example

Default Value

keywords

java developer

matchMode

BOOLEAN

language

sortOrder

ASC|DESC

orderBy

updatedDate or _score (sort by relevancy)

_score

page

pageSize

jobId

QCByb3M3QSGFQ7e

targetedTitle

Project Manager

filters.updateDate

ONE_DAY|TWO_DAYS|THREE_DAYS

filters.locationId

103867

filters.radius

filters.radiusUnit

mi or km

filters.willingToReclocate

true or false

filters.workPermitLocation

119388

filters.sectors

CAPITAL_MARKETS/DOCUMENTATION_STRUCTURIN|CAPITAL_MARKETS/OTHER

filters.yearsExperience

NO_EXPERIENCE|ONE_THREE_YERAS_EXPERIENCE

filters.languageLevels

EN|US|CMN
EN/BASIC|FR/FIRST_LANGUAGE

filters.educationL

evels

EDUCATION_LEVEL_1| EDUCATION_LEVEL_2

filters.positionTypes

PERMANENT, TEMPORARY, CONTRACT, SELF_EMPLOYED, INTERNSHIPS_AND_GRADUATE_TRAINEE

filters.salaryAmount

50000

filters.salaryCurrency

GBP, USD, EUR, CHF, JPY, AUD, SGD, HKD, CNY, CAD, SEK, DKK, NOK, ISK, ZAR, AED, QAR, BHD, SAR, KWD, OMR, NZD, NGN, INR, RUB, MYR

filters.salaryPeriod

PER_HOUR, PER_DAY, PER_WEEK, PER_MONTH, PER_YEAR;

filters.travelRate

NONE, TWENTY_FIVE_PERCENTS, FIFTY_PERCENTS, SEVENTY_FIVE_PERCENTS

filters.availability

UNDEFINED, IMMEDIATELY, ONE_WEEK, ONE_MONTH, TWO_MONTH, THREE_MONTH, SIX_MONTH;

filters.seniority

DIRECTOR/COMPANY_SECRETARY|DIRECTOR/SENIOR_DIRECTOR|SVP_HEAD_OF/ASSISTANT_DIRECTOR

Boolean search

Boolean search allows you to combine keywords with ‘operators’ such as AND, OR, NOT, (brackets) and “quotation marks” to produce more relevant search results.

For example:

keywords= (developer OR engineer OR programmer) AND (java OR scala OR c# OR python OR C++ OR react OR cloud OR devops OR AWS angular OR javascript) NOT ("project manager")

Ordering

The results obtained when searching for resumes are ordered by relevance by default.

Results can be sorted by resume update date

Example: orderBy=updatedDate

Sort order

Sort ascending or descending considering order-by parameter.

ASC, DESC

Example: sort-order=ASC

Return Format

There is one return format available.: JSON

Updated Within

Returns resumes updated within defined age.