Skip to main content
GET
/
applications
List applications
curl --request GET \
  --url https://api.gospott.com/applications \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "position": 123,
      "candidate": {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "middleName": "<string>",
        "secondLastName": "<string>",
        "avatarUrl": "<string>"
      },
      "vacancy": {
        "id": "<string>",
        "name": "<string>",
        "companyId": "<string>",
        "companyName": "<string>",
        "companyLogoUrl": "<string>",
        "jobBoards": [
          {
            "id": "<string>"
          }
        ]
      },
      "stage": {
        "id": "<string>",
        "order": 123,
        "name": "<string>",
        "colorHex": "<string>"
      }
    }
  ],
  "pagination": {
    "cursor": "<string>",
    "hasMore": true
  }
}

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.

Query Parameters

​
cursor
string

Base64-encoded cursor for pagination. Use the cursor value from a previous response to fetch the next page. Omit for the first page.

​
modifiedSince
default:1970-01-01T00:00:00.000Z

ISO 8601 datetime string to filter applications modified on or after this date. If omitted, returns all applications from the beginning of time.

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))$
Example:

"2024-01-01T00:00:00.000Z"

​
modifiedUntil

ISO 8601 datetime string to filter applications by sync watermark on or before this date. Useful for incremental syncing with a fixed upper bound.

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))$
Example:

"2024-12-31T23:59:59.999Z"

​
limit
integer
default:25
Required range: 1 <= x <= 50
​
candidateEmailAddresses
string<email>[]
Required array length: 1 - 25 elements
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
Example:
["candidate@example.com"]
​
isInbound
boolean

Filter by whether the application is inbound (true) or not (false).

​
include
enum<string>[]

Optional related resources to include in the response. Allowed values: lastActivity, candidate.latestWorkExperience, candidate.locations, candidate.emailAddresses, candidate.phoneNumbers, vacancy.clientContactTeam, vacancy.jobBoards.

Available options:
lastActivity,
candidate.latestWorkExperience,
candidate.locations,
candidate.emailAddresses,
candidate.phoneNumbers,
vacancy.clientContactTeam,
vacancy.jobBoards
Example:
["vacancy.jobBoards"]

Response

Successfully retrieved applications. Returns items array with pagination info containing cursor for the next page.

​
items
object[]
required
​
pagination
object
required