Skip to main content
GET
/
applications
/
{id}
Get application by ID
curl --request GET \
  --url http://localhost:3000/api/openapi/applications/{id} \
  --header 'x-api-key: <api-key>'
import requests

url = "http://localhost:3000/api/openapi/applications/{id}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('http://localhost:3000/api/openapi/applications/{id}', 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/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)

func main() {

url := "http://localhost:3000/api/openapi/applications/{id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-api-key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("http://localhost:3000/api/openapi/applications/{id}")
.header("x-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:3000/api/openapi/applications/{id}")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "company": "<string>",
  "role": "<string>",
  "location": "<string>",
  "salary": "<string>",
  "archived": true,
  "resumeId": "<string>",
  "source": "<string>",
  "tags": [
    "<string>"
  ],
  "sourceUrl": "<string>",
  "jobDescription": "<string>",
  "matchScore": 50,
  "aiMetadata": {},
  "notes": "<string>",
  "resumeFileUrl": "<string>",
  "resumeFileName": "<string>",
  "coverLetterUrl": "<string>",
  "coverLetterName": "<string>",
  "followUpAt": "2023-11-07T05:31:56Z",
  "followUpNote": "<string>",
  "contacts": [
    {
      "name": "<string>",
      "role": "",
      "type": ""
    }
  ],
  "activity": [
    {
      "id": "<string>",
      "text": "<string>",
      "at": "2023-11-07T05:31:56Z"
    }
  ],
  "appliedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key
string
header
required

The API key to authenticate requests.

Path Parameters

id
string
required

The ID of the application.

Response

200 - application/json

The job application.

id
string
required

The ID of the application.

company
string
required

The company applied to.

Minimum string length: 1
role
string
required

The role / job title.

Minimum string length: 1
location
string | null
required
salary
string | null
required
status
enum<string>
required

The current pipeline stage.

Available options:
saved,
applied,
screening,
interview,
offer,
rejected
archived
boolean
required
resumeId
string | null
required

The linked Reactive Resume, if any.

source
string | null
required
tags
string[]
required
sourceUrl
string | null
required
jobDescription
string | null
required
Maximum string length: 20000
matchScore
integer | null
required
Required range: 0 <= x <= 100
aiMetadata
object | null
required
notes
string | null
required
resumeFileUrl
string | null
required
resumeFileName
string | null
required
coverLetterUrl
string | null
required
coverLetterName
string | null
required
followUpAt
string<date-time> | null
required
followUpNote
string | null
required
contacts
object[]
required
activity
object[]
required
appliedAt
string<date-time>
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required