Skip to main content
GET
/
applications
/
{id}
Retrieve an application
curl --request GET \
  --url https://api.gospott.com/applications/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "position": 123,
  "stage": {
    "id": "<string>",
    "name": "<string>",
    "order": 123,
    "status": {
      "id": "<string>",
      "name": "<string>",
      "colorHex": "<string>"
    },
    "colorHex": "<string>",
    "templateId": "<string>"
  },
  "owner": {
    "owner": {
      "id": "<string>",
      "name": "<string>",
      "avatarUrl": "<string>",
      "deactivatedAt": "2023-11-07T05:31:56Z"
    }
  },
  "applicationState": {},
  "placements": [
    {
      "id": "<string>",
      "templateId": "<string>",
      "placedByUser": {
        "id": "<string>",
        "name": "<string>",
        "avatarUrl": "<string>",
        "deactivatedAt": "2023-11-07T05:31:56Z"
      },
      "placedAt": "2023-11-07T05:31:56Z",
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "grossFee": {
        "amount": 123
      },
      "netFee": {
        "amount": 123
      }
    }
  ],
  "commentCount": 123,
  "latestActivity": {
    "date": "2023-11-07T05:31:56Z",
    "triggeredByUser": {
      "id": "<string>",
      "name": "<string>",
      "avatarUrl": "<string>",
      "deactivatedAt": "2023-11-07T05:31:56Z"
    },
    "isInbound": true
  },
  "client": {
    "client": {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "domain": "<string>",
      "logoUrl": "<string>"
    }
  },
  "clientTeam": {
    "clientTeam": [
      {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "middleName": "<string>",
        "secondLastName": "<string>",
        "avatarUrl": "<string>",
        "candidateId": "<string>",
        "companyId": "<string>",
        "companyName": "<string>",
        "companyLogoUrl": "<string>"
      }
    ]
  },
  "vacancy": {
    "id": "<string>",
    "title": "<string>",
    "description": "<string>",
    "location": {
      "street1": "<string>",
      "street2": "<string>",
      "postalCode": "<string>",
      "city": "<string>",
      "region": "<string>",
      "state": "<string>",
      "country": "<string>",
      "rawCityCountry": "<string>",
      "latitude": 123,
      "longitude": 123,
      "formattedAddress": "<string>"
    },
    "client": {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "domain": "<string>",
      "logoUrl": "<string>"
    },
    "stage": {
      "id": "<string>",
      "order": 123,
      "name": "<string>",
      "colorHex": "<string>",
      "isOpen": true
    },
    "jobBoards": [
      {
        "id": "<string>"
      }
    ]
  },
  "comments": [
    {
      "id": "<string>",
      "content": "<string>",
      "canEdit": true,
      "createdBy": {
        "id": "<string>",
        "name": "<string>",
        "avatarUrl": "<string>",
        "deactivatedAt": "2023-11-07T05:31:56Z"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "modifiedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "interviews": [
    {
      "id": "<string>",
      "startTime": "2023-11-07T05:31:56Z",
      "endTime": "2023-11-07T05:31:56Z",
      "title": "<string>",
      "meetingId": "<string>"
    }
  ],
  "candidateMeetings": [
    {
      "id": "<string>",
      "title": "<string>",
      "startTime": "2023-11-07T05:31:56Z",
      "endTime": "2023-11-07T05:31:56Z",
      "isRecurringSeries": true,
      "recurringSeriesId": "<string>",
      "onlineJoinUrl": "<string>",
      "hasBot": true,
      "isAllDay": true,
      "participants": [
        {
          "name": "<string>",
          "email": "<string>"
        }
      ]
    }
  ],
  "candidate": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "middleName": "<string>",
    "secondLastName": "<string>",
    "avatarUrl": "<string>",
    "emails": [
      {
        "email": "jsmith@example.com",
        "purpose": "<string>",
        "isPrimary": true
      }
    ],
    "lastInteractionWith": {
      "id": "<string>",
      "name": "<string>",
      "avatarUrl": "<string>",
      "deactivatedAt": "2023-11-07T05:31:56Z"
    },
    "lastInteractionDate": "2023-11-07T05:31:56Z"
  },
  "rejection": {
    "id": "<string>",
    "rejectedByUser": {
      "id": "<string>",
      "name": "<string>",
      "avatarUrl": "<string>",
      "deactivatedAt": "2023-11-07T05:31:56Z"
    },
    "applicationId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "modifiedAt": "2023-11-07T05:31:56Z",
    "reason": "<string>",
    "rejectionLabels": [
      {
        "id": "<string>",
        "name": "<string>",
        "colorHex": "<string>"
      }
    ]
  },
  "internalTeam": {
    "internalTeam": [
      {
        "id": "<string>",
        "name": "<string>",
        "avatarUrl": "<string>",
        "deactivatedAt": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "notes": {
    "notes": [
      {
        "noteId": "<string>",
        "title": "<string>",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "freeText": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://api-docs.spott.io/llms.txt

Use this file to discover all available pages before exploring further.

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.

Available options:
vacancy.jobBoards
Example:
["vacancy.jobBoards"]

Response

Successfully retrieved application details

​
candidateApplicationType
enum<string>
required
Available options:
speculativeApplication,
standardApplication
​
id
string
required
Minimum string length: 1
​
position
number
required
​
stage
object
required
​
owner
object
required
​
applicationState
object
required
​
placements
object[]
required
​
commentCount
number
required
​
latestActivity
object
required
​
client
object
required
​
clientTeam
object
required
​
vacancy
object
required
​
comments
object[]
required
​
interviews
object[]
required
​
candidateMeetings
object[]
required
​
candidate
object
required
​
rejection
object
required
​
internalTeam
object
required
​
notes
object
required
​
freeText
string | null
required