Qodex.ai

candidates list

GET {{baseUrl}}/candidates

Returns a list of Candidate objects.

Request Params

KeyDatatypeRequiredDescription
created_afterstringIf provided, will only return objects created after this datetime.
created_beforestringIf provided, will only return objects created before this datetime.
cursorstringThe pagination cursor value.
expandstringWhich relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
first_namestringIf provided, will only return candidates with this first name.
include_deleted_databooleanWhether to include data that was deleted in the third-party service.
include_remote_databooleanWhether to include the original data Merge fetched from the third-party to produce these models.
last_namestringIf provided, will only return candidates with this last name.
modified_afterstringIf provided, will only return objects modified after this datetime.
modified_beforestringIf provided, will only return objects modified before this datetime.
page_sizenumberNumber of results to return per page.
remote_idstringThe API provider's ID for the given object.

HEADERS

KeyDatatypeRequiredDescription
X-Account-Tokenstring(Required) Token identifying the end user.
Acceptstring

RESPONSES

status: OK

{"next":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous":"cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results":[{"id":"521b18c2-4d01-4297-b451-19858d07c133","remote_id":"21198","first_name":"Gil","last_name":"Feig","company":"Columbia Dining App.","title":"Software Engineer","remote_created_at":"2021-10-15T00:00:00Z","remote_updated_at":"2021-10-16T00:00:00Z","last_interaction_at":"2021-10-17T00:00:00Z","is_private":true,"can_email":true,"locations":["San Francisco","New York","Miami"],"phone_numbers":[{"value":"+1234567890","phone_number_type":"MOBILE"}],"email_addresses":[{"value":"hello@merge.dev","email_address_type":"PERSONAL"}],"urls":[{"value":"http://alturl.com/p749b","url_type":"BLOG"}],"tags":["High-Priority"],"applications":["29eb9867-ce2a-403f-b8ce-f2844b89f078","b4d08e5c-de00-4d64-a29f-66addac9af99","4ff877d2-fb3e-4a5b-a7a5-168ddf2ffa56"],"attachments":["bea08964-32b4-4a20-8bb4-2612ba09de1d"],"custom_fields":{"nostrud0":{},"et_e":{}}},{"id":"521b18c2-4d01-4297-b451-19858d07c133","remote_id":"21198","first_name":"Gil","last_name":"Feig","company":"Columbia Dining App.","title":"Software Engineer","remote_created_at":"2021-10-15T00:00:00Z","remote_updated_at":"2021-10-16T00:00:00Z","last_interaction_at":"2021-10-17T00:00:00Z","is_private":true,"can_email":true,"locations":["San Francisco","New York","Miami"],"phone_numbers":[{"value":"+1234567890","phone_number_type":"MOBILE"}],"email_addresses":[{"value":"hello@merge.dev","email_address_type":"PERSONAL"}],"urls":[{"value":"http://alturl.com/p749b","url_type":"BLOG"}],"tags":["High-Priority"],"applications":["29eb9867-ce2a-403f-b8ce-f2844b89f078","b4d08e5c-de00-4d64-a29f-66addac9af99","4ff877d2-fb3e-4a5b-a7a5-168ddf2ffa56"],"attachments":["bea08964-32b4-4a20-8bb4-2612ba09de1d"],"custom_fields":{"labore0":{},"et85d":{}}}]}