get https://api.paradox.ai/api/v1/public/candidates
Get all company candidates
Results
Calling the candidates/ will return the full JSON object of all the candidates
By default, all the candidates are sent. You can limit the count using the limit query string.
Below are several key/value description
| Key | Description |
|---|---|
| candidate | Candidate information |
| start_keyword | Keyword text used by candidate to initiate the conversation |
| phone_number | phone number of the candidate |
| email address of the candidate | |
| updated_at | Last timestamp when candidate was updated |
| formatted_number | candidate's phone number in E.164 format (+12144930945) |
| edited_name | edited name of the candidate |
| created_at | timestamp when candidate was created |
| OID | id of the Olivia candidate |
| name | full name of the candidate |
| source | Possible values include SMS = 1, WIDGET = 2, RECRUITER_PAGE = 3, COMPANY_PAGE = 4, EMBEDDED_WIDGET = 5, WIT_WIDGET = 6 |
| group_name | group name of the candidate |
| external_oid | encrypted id of the Olivia candidate |
| referrer_email | Referrer's Email |
| referrer_name | Referrer's Name |
| external_referrer | External referrer |
| language_preference | Language code preference |
| conversation | List conversation |
| media_url | URL of the image/video sent by the candidate |
| message_type | Possible values include FREE_TEXT = 1, TK_TEXT = 2, ASK_ANY_THING_TEXT = 3, ASK_CONTINUE_TEXT = 4, PROMPT_NAME = 5, PROMPT_EMAIL = 6, PROMPT_PHONE = 7, ASK_DATA = 8, ASK_DOCUMENT = 9, ASK_LIST_SELECT = 10 |
| answer_text | answer text from Olivia / company user |
| updated_at | Last timestamp when conversation was updated |
| question_text | question text asked by the candidate |
| from_who | if 0, the reply was from the AI. Else, id of the company_user |
| created_at | timestamp when conversation was created |
| interview | Interview information |
| past_interview_at | timestamp of the last completed interview |
| scheduled_at | timestamp of the interview scheduled |
| interviewed | timestamp of the interview action with the candidate |
| scheduled_by | id of the company user who scheduled the interview with the candidate |
| interview_location_id | Location ID that will be interview |
| stage | Stages of candidte |
| viewed | if 1, the candidate was viewed by a company user |
| completed | if 1 the candidate completed the conversation |
| is_live | if 1 the candidate is on a live conversation |
| responded | if 1 the candidate has been responded to by a company user |
| status | Possible values include APPROVED = 1, PENDING = 2, ARCHIVED = 3, DRAFT = 4, SPAM = 5, UNKNOWN = 7, SCHEDULED = 8, CONFIRMED = 9, REMOVED = 10 |
| interview_stage | Possible values include NONE = 1, PENDING = 2, SCHEDULED = 3, SCHEDULE = 4, PENDING_INVITE = 5, PENDING_OPT_IN_REQUEST = 6, PENDING_INVITE_SMS_BS_HOUR = 7, NO_AVAILABILITY = 8, CANCELED = 9, CANCELED_REQUEST = 10 |
| note | List note |
| text | note text was created by user |
| created_at | timestamp when note was created |