Search Offers
Details#
This endpoint returns offers based on search criteria. It allows for Full-Text Search as well as results filtering. Perfect for a search component!
URL : /offers
Method :
Authentication
Auth is required to get hidden Offers. Only Admins or owners of hidden Offers will see them if showHidden is set
to true.
Parameters#
showHidden#
If active, will also return hidden offers, only for admin or offer owner.
limit#
Limits the number of results returned.
queryToken#
Used to continue a search after the previous one (often used with limit to have pagination). When using this parameter, it's not needed to pass the previous search parameters again.
info
You can get this token in the response of a previous call to this endpoint.
value#
Query for full text search.
jobType#
Filters the search results to only include ones of given type.
caution
Must be a valid Job Type (
currently ["FULL-TIME", "PART-TIME", "SUMMER INTERNSHIP", "CURRICULAR INTERNSHIP", "RESEARCH GRANT", "OTHER"]).
jobMinDuration#
Filters the search results to only include Offers with a jobMinDuration greater than given value.
jobMaxDuration#
Filters the search results to only include Offers with a jobMinDuration lower than given value.
fields#
Filters the search results to only include Offers with at least one of fields being one of given values.
caution
Must be a valid Field Type ( see list).
info
If you pass multiple values like: <url>/?fields=field1&fields=field2 it will be parsed as a String array.
technologies#
Filters the search results to only include Offers with at least one of technologies being one of given values.
caution
Must be a valid Technology Type ( see list).
info
If you pass multiple values like: <url>/?technologies=tech1&technologies=tech2 it will be parsed as a String array
sortBy#
Sorts the results by the given field.
caution
Must be a sortable Offer field (currently [
"title",
"publishDate",
"publishEndDate",
"jobMinDuration",
"jobMaxDuration",
"description",
"vacancies",
"jobType",
"ownerName",
"location",
]).
descending#
If active, will sort the results in descending order.
Response#
results#
Array of objects containing the offers found by the search
queryToken#
Token used to continue the search in a following request. It's needed to get the next page of results.
info
You can use this together with limit to achieve pagination
Request examples#
Example 1 - Valid Request#
Code :
- Request
- Response
Example 2 - Invalid job type#
Condition : If jobType contains an invalid value (e.g. jobType=fas)
Code :
- Request
- Response
Example 3 - Invalid fields#
Condition : If fields contains an invalid value (e.g. fields=fas)
Code :
- Request
- Response
Example 4 - Invalid technologies#
Condition : If technologies contains an invalid value (e.g. technologies=fas)
Code :
- Request
- Response
Example 5 - Invalid numeric fields#
Condition : If given a non-int to any of the numeric fields
Code :
- Request
- Response
Example 6 - Invalid queryToken#
Condition : If given an invalid queryToken (e.g. random string)
Code :
- Request
- Response