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>",
"locations": [
{
"street1": "<string>",
"street2": "<string>",
"postalCode": "<string>",
"city": "<string>",
"region": "<string>",
"state": "<string>",
"country": "<string>",
"latitude": 123,
"longitude": 123
}
],
"languages": [
{}
],
"restricted": true
}
'import requests
url = "https://api.gospott.com/vacancies"
payload = {
"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>",
"locations": [
{
"street1": "<string>",
"street2": "<string>",
"postalCode": "<string>",
"city": "<string>",
"region": "<string>",
"state": "<string>",
"country": "<string>",
"latitude": 123,
"longitude": 123
}
],
"languages": [{}],
"restricted": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>',
locations: [
{
street1: '<string>',
street2: '<string>',
postalCode: '<string>',
city: '<string>',
region: '<string>',
state: '<string>',
country: '<string>',
latitude: 123,
longitude: 123
}
],
languages: [{}],
restricted: true
})
};
fetch('https://api.gospott.com/vacancies', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gospott.com/vacancies",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>',
'locations' => [
[
'street1' => '<string>',
'street2' => '<string>',
'postalCode' => '<string>',
'city' => '<string>',
'region' => '<string>',
'state' => '<string>',
'country' => '<string>',
'latitude' => 123,
'longitude' => 123
]
],
'languages' => [
[
]
],
'restricted' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.gospott.com/vacancies"
payload := strings.NewReader("{\n \"companyId\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"stageId\": \"<string>\",\n \"salaryRange\": {\n \"min\": 123,\n \"max\": 123\n },\n \"location\": {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"endAt\": \"2023-11-07T05:31:56Z\",\n \"teamUserIds\": [\n \"<string>\"\n ],\n \"clientContactIds\": [\n \"<string>\"\n ],\n \"targetCompanyId\": \"<string>\",\n \"locations\": [\n {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n }\n ],\n \"languages\": [\n {}\n ],\n \"restricted\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.gospott.com/vacancies")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyId\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"stageId\": \"<string>\",\n \"salaryRange\": {\n \"min\": 123,\n \"max\": 123\n },\n \"location\": {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"endAt\": \"2023-11-07T05:31:56Z\",\n \"teamUserIds\": [\n \"<string>\"\n ],\n \"clientContactIds\": [\n \"<string>\"\n ],\n \"targetCompanyId\": \"<string>\",\n \"locations\": [\n {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n }\n ],\n \"languages\": [\n {}\n ],\n \"restricted\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gospott.com/vacancies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyId\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"stageId\": \"<string>\",\n \"salaryRange\": {\n \"min\": 123,\n \"max\": 123\n },\n \"location\": {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"endAt\": \"2023-11-07T05:31:56Z\",\n \"teamUserIds\": [\n \"<string>\"\n ],\n \"clientContactIds\": [\n \"<string>\"\n ],\n \"targetCompanyId\": \"<string>\",\n \"locations\": [\n {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n }\n ],\n \"languages\": [\n {}\n ],\n \"restricted\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>"
}{
"status": 0,
"message": "Company ID is required for creating a job",
"requestId": "<string>",
"statusCode": 400,
"error": "Bad Request"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>"
}Jobs
Create a job
Creates a new job. Requires a company ID and job details such as status, title, and description.
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>",
"locations": [
{
"street1": "<string>",
"street2": "<string>",
"postalCode": "<string>",
"city": "<string>",
"region": "<string>",
"state": "<string>",
"country": "<string>",
"latitude": 123,
"longitude": 123
}
],
"languages": [
{}
],
"restricted": true
}
'import requests
url = "https://api.gospott.com/vacancies"
payload = {
"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>",
"locations": [
{
"street1": "<string>",
"street2": "<string>",
"postalCode": "<string>",
"city": "<string>",
"region": "<string>",
"state": "<string>",
"country": "<string>",
"latitude": 123,
"longitude": 123
}
],
"languages": [{}],
"restricted": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>',
locations: [
{
street1: '<string>',
street2: '<string>',
postalCode: '<string>',
city: '<string>',
region: '<string>',
state: '<string>',
country: '<string>',
latitude: 123,
longitude: 123
}
],
languages: [{}],
restricted: true
})
};
fetch('https://api.gospott.com/vacancies', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gospott.com/vacancies",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>',
'locations' => [
[
'street1' => '<string>',
'street2' => '<string>',
'postalCode' => '<string>',
'city' => '<string>',
'region' => '<string>',
'state' => '<string>',
'country' => '<string>',
'latitude' => 123,
'longitude' => 123
]
],
'languages' => [
[
]
],
'restricted' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.gospott.com/vacancies"
payload := strings.NewReader("{\n \"companyId\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"stageId\": \"<string>\",\n \"salaryRange\": {\n \"min\": 123,\n \"max\": 123\n },\n \"location\": {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"endAt\": \"2023-11-07T05:31:56Z\",\n \"teamUserIds\": [\n \"<string>\"\n ],\n \"clientContactIds\": [\n \"<string>\"\n ],\n \"targetCompanyId\": \"<string>\",\n \"locations\": [\n {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n }\n ],\n \"languages\": [\n {}\n ],\n \"restricted\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.gospott.com/vacancies")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyId\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"stageId\": \"<string>\",\n \"salaryRange\": {\n \"min\": 123,\n \"max\": 123\n },\n \"location\": {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"endAt\": \"2023-11-07T05:31:56Z\",\n \"teamUserIds\": [\n \"<string>\"\n ],\n \"clientContactIds\": [\n \"<string>\"\n ],\n \"targetCompanyId\": \"<string>\",\n \"locations\": [\n {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n }\n ],\n \"languages\": [\n {}\n ],\n \"restricted\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gospott.com/vacancies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyId\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"stageId\": \"<string>\",\n \"salaryRange\": {\n \"min\": 123,\n \"max\": 123\n },\n \"location\": {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"endAt\": \"2023-11-07T05:31:56Z\",\n \"teamUserIds\": [\n \"<string>\"\n ],\n \"clientContactIds\": [\n \"<string>\"\n ],\n \"targetCompanyId\": \"<string>\",\n \"locations\": [\n {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n }\n ],\n \"languages\": [\n {}\n ],\n \"restricted\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>"
}{
"status": 0,
"message": "Company ID is required for creating a job",
"requestId": "<string>",
"statusCode": 400,
"error": "Bad Request"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>"
}Authorizations
API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.
Body
application/json
Minimum string length:
1Minimum string length:
1Minimum string length:
1Show child attributes
Show child attributes
Deprecated: use locations instead. A single physical location for the job. Ignored when locations is provided.
Show child attributes
Show child attributes
Available options:
fullTime, partTime, temporary, internship, permanent, fixedTermContract, interimOrTemporary, contract Available options:
remote, hybrid, onsite 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))$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))$Minimum string length:
1Minimum string length:
1Minimum string length:
1Physical locations for the job (0 to 15). Takes precedence over the deprecated location field.
Maximum array length:
15Show child attributes
Show child attributes
Languages required for the job (0 to 100).
Maximum array length:
100Show child attributes
Show child attributes
Response
Job created successfully. Returns the job ID.
Minimum string length:
1⌘I

