Skip to main content
GET
/
vacancies
/
{id}
Retrieve a job
curl --request GET \
  --url https://api.gospott.com/vacancies/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "client": {
    "client": {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "domain": "<string>",
      "logoUrl": "<string>"
    }
  },
  "name": {
    "name": "<string>"
  },
  "description": {
    "description": "<string>"
  },
  "stage": {
    "stage": {
      "id": "<string>",
      "order": 123,
      "name": "<string>",
      "colorHex": "<string>",
      "isOpen": true
    }
  },
  "createdAt": {
    "createdAt": "2023-11-07T05:31:56Z"
  },
  "startAt": {
    "startAt": "2023-11-07T05:31:56Z"
  },
  "endAt": {
    "endAt": "2023-11-07T05:31:56Z"
  },
  "salaryRange": {
    "salaryRange": {
      "min": 123,
      "max": 123
    }
  },
  "location": {
    "location": {
      "street1": "<string>",
      "street2": "<string>",
      "postalCode": "<string>",
      "city": "<string>",
      "region": "<string>",
      "state": "<string>",
      "country": "<string>",
      "rawCityCountry": "<string>",
      "latitude": 123,
      "longitude": 123,
      "formattedAddress": "<string>"
    }
  },
  "team": {
    "team": [
      {
        "userId": "<string>",
        "name": "<string>",
        "email": "jsmith@example.com",
        "avatarUrl": "<string>",
        "deactivatedAt": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "employmentType": {},
  "locationType": {},
  "clientTeam": {
    "clientTeam": [
      {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "middleName": "<string>",
        "secondLastName": "<string>",
        "avatarUrl": "<string>",
        "candidateId": "<string>",
        "companyId": "<string>",
        "companyName": "<string>",
        "companyLogoUrl": "<string>",
        "jobTitle": "<string>",
        "department": "<string>",
        "emails": [
          {
            "email": "jsmith@example.com",
            "isPrimary": true
          }
        ],
        "phoneNumbers": [
          {
            "phoneNumber": "<string>",
            "isPrimary": true
          }
        ]
      }
    ]
  },
  "scorecard": {
    "scorecards": [
      {
        "groupName": "<string>",
        "attributes": [
          {
            "attribute": "<string>"
          }
        ]
      }
    ]
  },
  "nextTaskDue": {
    "nextTaskDue": {
      "id": "<string>",
      "content": "<string>",
      "dueDate": "2023-11-07T05:31:56Z"
    }
  },
  "targetCompany": {
    "targetCompany": {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "domain": "<string>",
      "logoUrl": "<string>"
    }
  },
  "customAttributes": [
    {
      "attributeDefinitionId": "<string>",
      "label": "<string>",
      "aiFillOngoing": true,
      "aiOverridden": true,
      "isFilledByAI": true,
      "value": {
        "text": "<string>"
      }
    }
  ],
  "stageTotals": {
    "totals": [
      {
        "id": "<string>",
        "name": "<string>",
        "order": 123,
        "total": 123
      }
    ]
  },
  "jobBoards": [
    {
      "id": "<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

Response

Successfully retrieved job details

id
string
required
Minimum string length: 1
client
object
required
name
object
required
description
object
required
stage
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
targetCompany
object
required
customAttributes
object[]
required
stageTotals
object
required
jobBoards
object[]

Job board postings associated with this job. Only included when "jobBoards" is specified in the include parameter.