Export API login endpoint. In case of successful authentication you will receive an authentication key in the response headers: X-Apikey. When accessing any other endpoints you must send this key via an Authorization header.
| Name | Requirement | Type | Description |
|---|---|---|---|
| string | Email address | ||
| password | string | Password |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| Name | Information | ||||||
|---|---|---|---|---|---|---|---|
| page |
|
||||||
| limit |
|
||||||
| filter |
|
||||||
| sort |
|
||||||
| keyword |
|
||||||
| location |
|
| Parameter | Type | Versions | Description |
|---|---|---|---|
200 |
|||
| jobs[] | array of objects (Job) | * | |
| jobs[][slug] | string | * | Job identifier. |
| jobs[][title] | string | * | Job title. |
| jobs[][description] | string | * | |
| jobs[][lastActivity] | DateTime | * | |
| jobs[][applicationStats] | array | * | Number of applicants for each status. Keys: 1-new, 2-viewed, 3-interview, 4-rejected. |
| Name | Requirement | Type | Description |
|---|---|---|---|
| slug |
| Name | Information | ||||||
|---|---|---|---|---|---|---|---|
| page |
|
||||||
| sort |
|
||||||
| status |
|
||||||
| show |
|
||||||
| search_field |
|
||||||
| keyword |
|
||||||
| location |
|
| Parameter | Type | Versions | Description |
|---|---|---|---|
200 |
|||
| applicants[] | array of objects (Applicant) | * | |
| applicants[][user] | object (User) | * | User who applied to job or got unlocked. |
| applicants[][user][lastLogin] | DateTime | * | |
| applicants[][user][lockedForAccount] | boolean | * | |
| applicants[][user][slug] | string | * | |
| applicants[][status] | integer | * | Status of the applied user: New, Viewed, Interview, etc. |
| applicants[][createdAt] | DateTime | * | |
| applicants[][viewedAt] | DateTime | * |
Applicant details.
| Name | Requirement | Type | Description |
|---|---|---|---|
| job_slug | |||
| user_slug |
| Parameter | Type | Versions | Description |
|---|---|---|---|
200 |
|||
| user | object (User) | * | User who applied to job or got unlocked. |
| user[email] | string | * | |
| user[lastLogin] | DateTime | * | |
| user[phone] | object (PhoneNumber) | >=1.0.1 | |
| user[phone][country] | object (PhoneCountry) | * | |
| user[phone][country][countryCode] | string | * | |
| user[phone][country][regionCode] | string | * | |
| user[phone][country][regionName] | string | * | |
| user[phone][number] | string | * | |
| user[fullName] | string | * | |
| user[profileUrl] | string | * | |
| user[gender] | object (Gender) | * | |
| user[profileImage] | string | * | |
| user[lockedForAccount] | boolean | * | |
| user[resume] | object (Resume) | * | Get Main resume. |
| user[resume][driversLicence] | boolean | * | |
| user[resume][relocation] | boolean | * | |
| user[resume][partTime] | boolean | * | |
| user[resume][travel] | boolean | * | |
| user[resume][skills][] | array of strings | * | |
| user[resume][withRemote] | boolean | * | |
| user[resume][birthDate] | DateTime | * | |
| user[resume][experience][] | array of objects (Experience) | * | |
| user[resume][experience][][fromDate] | DateTime | * | |
| user[resume][experience][][companyName] | string | * | |
| user[resume][experience][][position] | object (Location) | * | |
| user[resume][experience][][position][cityCountry] | string | * | Get formatted address. |
| user[resume][experience][][toDate] | DateTime | * | |
| user[resume][experience][][name][] | array of strings | * | |
| user[resume][study][] | array of objects (Study) | * | |
| user[resume][study][][certificate] | object (StudyLevel) | * | |
| user[resume][study][][faculty] | object (Faculty) | * | |
| user[resume][study][][institution][] | array of strings | * | |
| user[resume][study][][admissionYear] | integer | * | |
| user[resume][study][][graduationYear] | integer | * | |
| user[resume][study][][finished] | boolean | * | |
| user[resume][study][][location] | string | * | |
| user[resume][picture] | object (Image) | * | |
| user[resume][spokenLanguages][] | array of objects (SpokenLanguage) | * | |
| user[resume][spokenLanguages][][name] | string | * | |
| user[resume][spokenLanguages][][language] | string | * | |
| user[resume][spokenLanguages][][level] | object (SpokenLanguageLevel) | * | |
| user[resume][spokenLanguages][][level][id] | custom handler result for (int) | * | |
| user[resume][spokenLanguages][][level][name] | string | * | |
| user[resume][attachments][] | array of objects (ResumeAttachment) | * | |
| user[location] | object (Location) | * | |
| user[location][cityCountry] | string | * | Get formatted address. |
| user[slug] | string | * | |
| status | integer | * | Status of the applied user: New, Viewed, Interview, etc. |
| applied | boolean | * | If the user made the application by itself = true If the user is applicant after cv search and unlock = false. |
| createdAt | DateTime | * | |
| viewedAt | DateTime | * |
Documentation auto-generated on Thu, 18 Mar 21 12:52:48 +0000