Appearance
Applications
This page documents on how to:
Fetch applications
Fetch a list of applications created by your Jobboard.
Scope
applications_read
Endpoint
GET /jobboards/applications
The payload in this endpoint is paginated. Information will be provided in the headers.
Consult the guide for paginationAccepted params
All parameters should be in the querystring.
| Param | Type | Example Value | Default | Description |
|---|---|---|---|---|
company_id | Integer | 1 | null | Only returns applications from this Company (can be replaced by company_slug) |
company_slug | String | my-awesome-company | null | Only returns applications from this Company (can be replaced by company_id) |
entity_id | Integer | 1 | null | Only returns applications from this Entity (formely designated as a Brand) |
campaign_id | Integer | 5 | null | Only returns applications from this Campaign |
embed | String | applicant | null | Wanted embedded data, separated with comas. Available values: [applicant] |
order | String | created_at | created_at | Chosen field for ordering the data. Available values: [created_at] |
sort | String | desc | desc | Way of sorting the data. Available values: [asc,desc] |
page | Integer | 1 | 1 | Page to fetch |
per_page | Integer | 50 | 50 | Quantity of data by page (max value is 50) |
Embedded data
In this endpoint, embedded data can be requested:
applicant:applicantrelated to thisapplication
Examples
Find all applications from a company with id 44, with data about each applicant.
GET https://api.talentview.fr/v2/jobboards/applications?company_id=44&embed=applicant
Create application
Create an Application for a specific Applicant account.
Scope
applications_write
Endpoint
POST /jobboards/applications
Accepted params
All parameters should be in the request's body.
| Param | Type | Example value | Required | Description |
|---|---|---|---|---|
company_id | Integer | 1 | ✓ | Company id linked to the Application |
campaign_id | Integer | 127 | ✓ | Campaign id linked to the Application. The Campaign has to be broadcasted on your Jobboard |
applicant_id | Integer | 42 | ✓ / ✗ | Applicant id who owns the Application. (required if applicant_email is undefined) |
applicant_email | String | "foo@bar.com" | ✓ / ✗ | Applicant email who owns the Application. (required if application_id) is undefined |
application | Object | - | ✗ | Application data |
application["resume"] | Object | - | ✗ | Uploading a resume will update your Application status to "complete". To upload a resume, both base64 and mime_type following fields are required. NB: the resume is uploaded asynchronously. |
application["resume"]["base64"] | String | "JVBERi0xLjQ..." | ✓ / ✗ | Resume encoded in base64. |
application["resume"]["mime_type"] | String | "pdf" | ✓ / ✗ | Mime type of the file. Available values: ["pdf", "jpg", "png", "doc", "docx"] |
Example
Create an application from an applicant's email address.
URL:
POST https://api.talentview.fr/v2/jobboards/applications
BODY:
json
{
"company_id": 1,
"campaign_id": 1,
"applicant_email": "foo@bar.com",
"application": {
"resume": {
"mime_type": "pdf",
"base64": "iVBORw0K..."
}
}
}