Skip to main content
POST
/
vacancies
Create a job
curl --request POST \
  --url https://api.gospott.com/vacancies \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "companyId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "stageId": "<string>",
  "salaryRange": {
    "min": 123,
    "max": 123
  },
  "location": {
    "street1": "<string>",
    "street2": "<string>",
    "postalCode": "<string>",
    "city": "<string>",
    "region": "<string>",
    "state": "<string>",
    "country": "<string>",
    "latitude": 123,
    "longitude": 123
  },
  "startAt": "2023-11-07T05:31:56Z",
  "endAt": "2023-11-07T05:31:56Z",
  "teamUserIds": [
    "<string>"
  ],
  "clientContactIds": [
    "<string>"
  ],
  "targetCompanyId": "<string>"
}
'
{
  "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.

Body

application/json
​
companyId
string
required
Minimum string length: 1
​
name
string
required
Minimum string length: 1
​
description
string | null
required
​
stageId
string
required
Minimum string length: 1
​
salaryRange
object
required
​
location
object
required
​
employmentType
enum<string> | null
required
Available options:
fullTime,
partTime,
temporary,
internship,
permanent,
fixedTermContract,
interimOrTemporary
​
locationType
enum<string> | null
required
Available options:
remote,
hybrid,
onsite
​
startAt
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))$
​
endAt
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))$
​
teamUserIds
string[]
required
Minimum string length: 1
​
clientContactIds
string[]
required
Minimum string length: 1
​
targetCompanyId
string | null
required
Minimum string length: 1

Response

Job created successfully. Returns the job ID.

​
id
string
required
Minimum string length: 1