API Reference

List Candidates

Queries and lists candidates

Log in to see full request history
Query Params
filters
object

Search filters

It's possible to filter the list with filters combination:

filters[tea_id]=%uuid% - filter by specific TEA from the TEA group

filters[refs][evolia]=123456 - filter by candidate's Evolia ID

filters['created_at']['eq']=%date% - filter by creation date where created_at >= '%date% 00:00:00' and created_at <= '%date% 23:59:59'

filters['created_at']['gte']=%date_1% - filter by creation date where created_at >= '%date_1%'

filters['created_at']['lte']=%date_2% - filter by creation date where created_at <= '%date_2%'

pagination:

The result list uses cursor-based pagination for better optimization for interactions via the big amount of records

after

To get 1st page with initial cursor values, request as

API_URL?limit=100

parse 'next' value and navigate to next page, as

URL?limit=100&after={next} to retrieve the next page of results.

before

parse 'before' value from next pages response and navigate to previouse page, as

URL?limit=100&before={prev}

integer
≥ 0

Number of entries per page

string

Cursor to limit the results at the end

string

Cursor to limit the results at the beginning

Responses

400

Returned in case the request contained invalid parameters

404

Returned in case the requested item can not be found

Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json