Skip to main content
POST
/
vacancies
Create a new job
curl --request POST \
  --url https://api.gospott.com/vacancies \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "status": "open",
  "name": "<string>",
  "description": "<string>",
  "salaryRange": {
    "currency": "USD",
    "min": 123,
    "max": 123
  },
  "location": {
    "type": "primary_home",
    "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>"
  ],
  "clientTeamUserIds": [
    "<string>"
  ],
  "employmentType": "fullTime",
  "locationType": "remote",
  "stageId": "<string>"
}
'
{
  "id": "<string>"
}

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

​
companyId
string
required

ID of the company for which to create the job

Body

application/json
​
status
enum<string>
required
Available options:
open,
filled,
lost,
closed,
hold
​
name
string
required
​
description
string | null
required
​
salaryRange
object
required
​
location
object
required
​
startAt
string<date-time> | null
required
​
endAt
string<date-time> | null
required
​
teamUserIds
string[]
required
​
clientTeamUserIds
string[]
required
​
employmentType
enum<string> | null
Available options:
fullTime,
partTime,
temporary,
internship
​
locationType
enum<string> | null
Available options:
remote,
hybrid,
onsite
​
stageId
string

Response

Job created successfully. Returns the job ID.

​
id
string
required