Create a job application
curl --request POST \
--url http://localhost:3000/api/openapi/applications \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"company": "<string>",
"role": "<string>",
"location": "<string>",
"salary": "<string>",
"source": "<string>",
"sourceUrl": "<string>",
"jobDescription": "<string>",
"notes": "<string>",
"resumeFileUrl": "<string>",
"resumeFileName": "<string>",
"coverLetterUrl": "<string>",
"coverLetterName": "<string>",
"followUpAt": "2023-11-07T05:31:56Z",
"followUpNote": "<string>",
"contacts": [
{
"name": "<string>",
"role": "",
"type": ""
}
],
"resumeId": "<string>",
"tags": [
"<string>"
]
}
'import requests
url = "http://localhost:3000/api/openapi/applications"
payload = {
"company": "<string>",
"role": "<string>",
"location": "<string>",
"salary": "<string>",
"source": "<string>",
"sourceUrl": "<string>",
"jobDescription": "<string>",
"notes": "<string>",
"resumeFileUrl": "<string>",
"resumeFileName": "<string>",
"coverLetterUrl": "<string>",
"coverLetterName": "<string>",
"followUpAt": "2023-11-07T05:31:56Z",
"followUpNote": "<string>",
"contacts": [
{
"name": "<string>",
"role": "",
"type": ""
}
],
"resumeId": "<string>",
"tags": ["<string>"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
company: '<string>',
role: '<string>',
location: '<string>',
salary: '<string>',
source: '<string>',
sourceUrl: '<string>',
jobDescription: '<string>',
notes: '<string>',
resumeFileUrl: '<string>',
resumeFileName: '<string>',
coverLetterUrl: '<string>',
coverLetterName: '<string>',
followUpAt: '2023-11-07T05:31:56Z',
followUpNote: '<string>',
contacts: [{name: '<string>', role: '', type: ''}],
resumeId: '<string>',
tags: ['<string>']
})
};
fetch('http://localhost:3000/api/openapi/applications', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/openapi/applications",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'company' => '<string>',
'role' => '<string>',
'location' => '<string>',
'salary' => '<string>',
'source' => '<string>',
'sourceUrl' => '<string>',
'jobDescription' => '<string>',
'notes' => '<string>',
'resumeFileUrl' => '<string>',
'resumeFileName' => '<string>',
'coverLetterUrl' => '<string>',
'coverLetterName' => '<string>',
'followUpAt' => '2023-11-07T05:31:56Z',
'followUpNote' => '<string>',
'contacts' => [
[
'name' => '<string>',
'role' => '',
'type' => ''
]
],
'resumeId' => '<string>',
'tags' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/api/openapi/applications"
payload := strings.NewReader("{\n \"company\": \"<string>\",\n \"role\": \"<string>\",\n \"location\": \"<string>\",\n \"salary\": \"<string>\",\n \"source\": \"<string>\",\n \"sourceUrl\": \"<string>\",\n \"jobDescription\": \"<string>\",\n \"notes\": \"<string>\",\n \"resumeFileUrl\": \"<string>\",\n \"resumeFileName\": \"<string>\",\n \"coverLetterUrl\": \"<string>\",\n \"coverLetterName\": \"<string>\",\n \"followUpAt\": \"2023-11-07T05:31:56Z\",\n \"followUpNote\": \"<string>\",\n \"contacts\": [\n {\n \"name\": \"<string>\",\n \"role\": \"\",\n \"type\": \"\"\n }\n ],\n \"resumeId\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3000/api/openapi/applications")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"company\": \"<string>\",\n \"role\": \"<string>\",\n \"location\": \"<string>\",\n \"salary\": \"<string>\",\n \"source\": \"<string>\",\n \"sourceUrl\": \"<string>\",\n \"jobDescription\": \"<string>\",\n \"notes\": \"<string>\",\n \"resumeFileUrl\": \"<string>\",\n \"resumeFileName\": \"<string>\",\n \"coverLetterUrl\": \"<string>\",\n \"coverLetterName\": \"<string>\",\n \"followUpAt\": \"2023-11-07T05:31:56Z\",\n \"followUpNote\": \"<string>\",\n \"contacts\": [\n {\n \"name\": \"<string>\",\n \"role\": \"\",\n \"type\": \"\"\n }\n ],\n \"resumeId\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/openapi/applications")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"company\": \"<string>\",\n \"role\": \"<string>\",\n \"location\": \"<string>\",\n \"salary\": \"<string>\",\n \"source\": \"<string>\",\n \"sourceUrl\": \"<string>\",\n \"jobDescription\": \"<string>\",\n \"notes\": \"<string>\",\n \"resumeFileUrl\": \"<string>\",\n \"resumeFileName\": \"<string>\",\n \"coverLetterUrl\": \"<string>\",\n \"coverLetterName\": \"<string>\",\n \"followUpAt\": \"2023-11-07T05:31:56Z\",\n \"followUpNote\": \"<string>\",\n \"contacts\": [\n {\n \"name\": \"<string>\",\n \"role\": \"\",\n \"type\": \"\"\n }\n ],\n \"resumeId\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body"<string>"Applications
Create a job application
Creates a new job application in the pipeline. Company and role are required; all other fields (stage, location, salary, source, linked resume, follow-up, notes, contacts) are optional. Requires authentication.
POST
/
applications
Create a job application
curl --request POST \
--url http://localhost:3000/api/openapi/applications \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"company": "<string>",
"role": "<string>",
"location": "<string>",
"salary": "<string>",
"source": "<string>",
"sourceUrl": "<string>",
"jobDescription": "<string>",
"notes": "<string>",
"resumeFileUrl": "<string>",
"resumeFileName": "<string>",
"coverLetterUrl": "<string>",
"coverLetterName": "<string>",
"followUpAt": "2023-11-07T05:31:56Z",
"followUpNote": "<string>",
"contacts": [
{
"name": "<string>",
"role": "",
"type": ""
}
],
"resumeId": "<string>",
"tags": [
"<string>"
]
}
'import requests
url = "http://localhost:3000/api/openapi/applications"
payload = {
"company": "<string>",
"role": "<string>",
"location": "<string>",
"salary": "<string>",
"source": "<string>",
"sourceUrl": "<string>",
"jobDescription": "<string>",
"notes": "<string>",
"resumeFileUrl": "<string>",
"resumeFileName": "<string>",
"coverLetterUrl": "<string>",
"coverLetterName": "<string>",
"followUpAt": "2023-11-07T05:31:56Z",
"followUpNote": "<string>",
"contacts": [
{
"name": "<string>",
"role": "",
"type": ""
}
],
"resumeId": "<string>",
"tags": ["<string>"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
company: '<string>',
role: '<string>',
location: '<string>',
salary: '<string>',
source: '<string>',
sourceUrl: '<string>',
jobDescription: '<string>',
notes: '<string>',
resumeFileUrl: '<string>',
resumeFileName: '<string>',
coverLetterUrl: '<string>',
coverLetterName: '<string>',
followUpAt: '2023-11-07T05:31:56Z',
followUpNote: '<string>',
contacts: [{name: '<string>', role: '', type: ''}],
resumeId: '<string>',
tags: ['<string>']
})
};
fetch('http://localhost:3000/api/openapi/applications', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/openapi/applications",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'company' => '<string>',
'role' => '<string>',
'location' => '<string>',
'salary' => '<string>',
'source' => '<string>',
'sourceUrl' => '<string>',
'jobDescription' => '<string>',
'notes' => '<string>',
'resumeFileUrl' => '<string>',
'resumeFileName' => '<string>',
'coverLetterUrl' => '<string>',
'coverLetterName' => '<string>',
'followUpAt' => '2023-11-07T05:31:56Z',
'followUpNote' => '<string>',
'contacts' => [
[
'name' => '<string>',
'role' => '',
'type' => ''
]
],
'resumeId' => '<string>',
'tags' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/api/openapi/applications"
payload := strings.NewReader("{\n \"company\": \"<string>\",\n \"role\": \"<string>\",\n \"location\": \"<string>\",\n \"salary\": \"<string>\",\n \"source\": \"<string>\",\n \"sourceUrl\": \"<string>\",\n \"jobDescription\": \"<string>\",\n \"notes\": \"<string>\",\n \"resumeFileUrl\": \"<string>\",\n \"resumeFileName\": \"<string>\",\n \"coverLetterUrl\": \"<string>\",\n \"coverLetterName\": \"<string>\",\n \"followUpAt\": \"2023-11-07T05:31:56Z\",\n \"followUpNote\": \"<string>\",\n \"contacts\": [\n {\n \"name\": \"<string>\",\n \"role\": \"\",\n \"type\": \"\"\n }\n ],\n \"resumeId\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3000/api/openapi/applications")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"company\": \"<string>\",\n \"role\": \"<string>\",\n \"location\": \"<string>\",\n \"salary\": \"<string>\",\n \"source\": \"<string>\",\n \"sourceUrl\": \"<string>\",\n \"jobDescription\": \"<string>\",\n \"notes\": \"<string>\",\n \"resumeFileUrl\": \"<string>\",\n \"resumeFileName\": \"<string>\",\n \"coverLetterUrl\": \"<string>\",\n \"coverLetterName\": \"<string>\",\n \"followUpAt\": \"2023-11-07T05:31:56Z\",\n \"followUpNote\": \"<string>\",\n \"contacts\": [\n {\n \"name\": \"<string>\",\n \"role\": \"\",\n \"type\": \"\"\n }\n ],\n \"resumeId\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/openapi/applications")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"company\": \"<string>\",\n \"role\": \"<string>\",\n \"location\": \"<string>\",\n \"salary\": \"<string>\",\n \"source\": \"<string>\",\n \"sourceUrl\": \"<string>\",\n \"jobDescription\": \"<string>\",\n \"notes\": \"<string>\",\n \"resumeFileUrl\": \"<string>\",\n \"resumeFileName\": \"<string>\",\n \"coverLetterUrl\": \"<string>\",\n \"coverLetterName\": \"<string>\",\n \"followUpAt\": \"2023-11-07T05:31:56Z\",\n \"followUpNote\": \"<string>\",\n \"contacts\": [\n {\n \"name\": \"<string>\",\n \"role\": \"\",\n \"type\": \"\"\n }\n ],\n \"resumeId\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body"<string>"Authorizations
The API key to authenticate requests.
Body
application/json
The company applied to.
Minimum string length:
1The role / job title.
Minimum string length:
1Maximum string length:
20000Show child attributes
Show child attributes
The linked Reactive Resume, if any.
Available options:
saved, applied, screening, interview, offer, rejected Response
200 - application/json
The ID of the newly created application.
The ID of the created application.
⌘I