Skip to main content
GET
Retrieve an application

Authorizations

x-api-key
string
header
required

API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.

Path Parameters

id
string
required

Query Parameters

include
enum<string>[]

Optional related resources to include in the response. Allowed values: vacancy.jobBoards.

Maximum array length: 1
Available options:
vacancy.jobBoards
Example:

Response

Successfully retrieved application details

candidateApplicationType
enum<string>
required
Available options:
speculativeApplication,
standardApplication
id
string
required
Minimum string length: 1
position
number
required
createdAt
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
stage
object
required
owner
object
required
applicationState
object
required
placements
object[]
required

Contains at most 25 placements, ordered by placement time descending, then ID ascending.

commentCount
number
required
latestActivity
object
required
client
object
required
clientTeam
object
required
vacancy
object | null
required
comments
object[]
required

Contains at most 25 comments, ordered by creation time descending, then ID ascending.

interviews
object[]
required

Contains at most 50 interviews, ordered by start time descending, then interview ID ascending.

candidateMeetings
object[]
required

Contains at most 10 upcoming meetings, ordered by start time ascending, then meeting ID ascending.

candidate
object
required
rejection
object | null
required
internalTeam
object
required
notes
object
required
freeText
string | null
required