Skip to main content
GET
/
vacancies
/
{id}
Get vacancy by ID
curl --request GET \
  --url https://api.gospott.com/vacancies/{id} \
  --header 'x-api-key: <api-key>'
{
  "stageTotals": {
    "viewType": "vacancyStageTotals",
    "totals": [
      {
        "type": "speculative",
        "id": "<string>",
        "name": "<string>",
        "order": 123,
        "total": 123
      }
    ]
  },
  "customAttributes": [
    {
      "value": "<any>",
      "attributeDefinitionId": "<string>",
      "label": "<string>",
      "description": "<string>",
      "filledByAI": true,
      "options": [
        "<string>"
      ]
    }
  ],
  "clientPortalId": "<string>",
  "lastRankedAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "client": {
    "viewType": "vacancyClient",
    "client": {
      "industry": "Accessible Architecture and Design",
      "size": "1 employee",
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "domain": "<string>",
      "logoUrl": "<string>"
    }
  },
  "name": {
    "viewType": "vacancyName",
    "name": "<string>"
  },
  "description": {
    "viewType": "vacancyDescription",
    "description": "<string>"
  },
  "status": {
    "status": "open",
    "viewType": "vacancyStatus"
  },
  "createdAt": {
    "viewType": "vacancyCreatedAt",
    "createdAt": "2023-11-07T05:31:56Z"
  },
  "startAt": {
    "viewType": "vacancyStartAt",
    "startAt": "2023-11-07T05:31:56Z"
  },
  "endAt": {
    "viewType": "vacancyEndAt",
    "endAt": "2023-11-07T05:31:56Z"
  },
  "salaryRange": {
    "viewType": "vacancySalaryRange",
    "salaryRange": {
      "currency": "USD",
      "min": 123,
      "max": 123
    }
  },
  "location": {
    "viewType": "vacancyLocation",
    "location": {
      "type": "primary_home",
      "street1": "<string>",
      "street2": "<string>",
      "postalCode": "<string>",
      "city": "<string>",
      "region": "<string>",
      "state": "<string>",
      "country": "<string>",
      "rawCityCountry": "<string>",
      "latitude": 123,
      "longitude": 123,
      "formattedAddress": "<string>"
    }
  },
  "team": {
    "viewType": "vacancyTeam",
    "team": [
      {
        "userId": "<string>",
        "name": "<string>",
        "email": "<string>",
        "avatarUrl": "<string>",
        "deactivatedAt": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "employmentType": {
    "employmentType": "fullTime",
    "viewType": "vacancyEmploymentType"
  },
  "locationType": {
    "locationType": "remote",
    "viewType": "vacancyLocationType"
  },
  "clientTeam": {
    "viewType": "<string>",
    "clientTeam": [
      {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "middleName": "<string>",
        "secondLastName": "<string>",
        "avatarUrl": "<string>",
        "candidateId": "<string>",
        "companyId": "<string>",
        "companyName": "<string>",
        "companyLogoUrl": "<string>"
      }
    ]
  },
  "scorecard": {
    "viewType": "vacancyScorecard",
    "scorecards": [
      {
        "group_name": "<string>",
        "attributes": [
          {
            "attribute": "<string>"
          }
        ]
      }
    ]
  },
  "nextTaskDue": {
    "viewType": "vacancyNextTaskDue",
    "nextTaskDue": {
      "id": "<string>",
      "content": "<string>",
      "dueDate": "2023-11-07T05:31:56Z"
    }
  }
}

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

Response

Successfully retrieved vacancy details

stageTotals
object
required
customAttributes
object[]
required
clientPortalId
string | null
required
lastRankedAt
string<date-time> | null
required
id
string
required
client
object
required
name
object
required
description
object
required
status
object
required
createdAt
object
required
startAt
object
required
endAt
object
required
salaryRange
object
required
location
object
required
team
object
required
employmentType
object
required
locationType
object
required
clientTeam
object
required
scorecard
object
required
nextTaskDue
object
required