Submit spontaneous application
curl --request POST \
--url https://api.gospott.com/candidate-portal/open-application \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"firstName": "<string>",
"lastName": "<string>",
"coverLetterAttachmentId": "<string>",
"email": "jsmith@example.com",
"phoneNumber": "<string>",
"linkedinUrl": "<string>",
"location": {
"street1": "<string>",
"street2": "<string>",
"postalCode": "<string>",
"city": "<string>",
"region": "<string>",
"state": "<string>",
"country": "<string>",
"latitude": 0,
"longitude": 0
},
"cvAttachmentId": "<string>",
"dateOfBirth": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.gospott.com/candidate-portal/open-application"
payload = {
"firstName": "<string>",
"lastName": "<string>",
"coverLetterAttachmentId": "<string>",
"email": "jsmith@example.com",
"phoneNumber": "<string>",
"linkedinUrl": "<string>",
"location": {
"street1": "<string>",
"street2": "<string>",
"postalCode": "<string>",
"city": "<string>",
"region": "<string>",
"state": "<string>",
"country": "<string>",
"latitude": 0,
"longitude": 0
},
"cvAttachmentId": "<string>",
"dateOfBirth": "2023-11-07T05:31:56Z"
}
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({
firstName: '<string>',
lastName: '<string>',
coverLetterAttachmentId: '<string>',
email: 'jsmith@example.com',
phoneNumber: '<string>',
linkedinUrl: '<string>',
location: {
street1: '<string>',
street2: '<string>',
postalCode: '<string>',
city: '<string>',
region: '<string>',
state: '<string>',
country: '<string>',
latitude: 0,
longitude: 0
},
cvAttachmentId: '<string>',
dateOfBirth: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.gospott.com/candidate-portal/open-application', 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/candidate-portal/open-application",
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([
'firstName' => '<string>',
'lastName' => '<string>',
'coverLetterAttachmentId' => '<string>',
'email' => 'jsmith@example.com',
'phoneNumber' => '<string>',
'linkedinUrl' => '<string>',
'location' => [
'street1' => '<string>',
'street2' => '<string>',
'postalCode' => '<string>',
'city' => '<string>',
'region' => '<string>',
'state' => '<string>',
'country' => '<string>',
'latitude' => 0,
'longitude' => 0
],
'cvAttachmentId' => '<string>',
'dateOfBirth' => '2023-11-07T05:31:56Z'
]),
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/candidate-portal/open-application"
payload := strings.NewReader("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"coverLetterAttachmentId\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phoneNumber\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\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\": 0,\n \"longitude\": 0\n },\n \"cvAttachmentId\": \"<string>\",\n \"dateOfBirth\": \"2023-11-07T05:31:56Z\"\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/candidate-portal/open-application")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"coverLetterAttachmentId\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phoneNumber\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\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\": 0,\n \"longitude\": 0\n },\n \"cvAttachmentId\": \"<string>\",\n \"dateOfBirth\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gospott.com/candidate-portal/open-application")
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 \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"coverLetterAttachmentId\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phoneNumber\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\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\": 0,\n \"longitude\": 0\n },\n \"cvAttachmentId\": \"<string>\",\n \"dateOfBirth\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"status": 0,
"message": "Invalid email format",
"requestId": "<string>",
"category": "MALFORMED_REQUEST",
"statusCode": 400,
"error": "Bad Request"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>",
"category": "MALFORMED_REQUEST"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>",
"category": "MALFORMED_REQUEST"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>",
"category": "MALFORMED_REQUEST"
}{
"status": 409,
"category": "RESOURCE_ALREADY_EXISTS",
"message": "Resource already exists",
"requestId": "<string>"
}{
"status": 500,
"category": "INTERNAL_ERROR",
"message": "Internal server error",
"requestId": "<string>"
}Candidate Portal
Submit spontaneous application
Submit a spontaneous application. The CV is optional: without one, the candidate is created from the submitted details. An existing candidate with the same email, phone number or LinkedIn URL is reused. Requires open applications to be enabled for the organization.
POST
/
candidate-portal
/
open-application
Submit spontaneous application
curl --request POST \
--url https://api.gospott.com/candidate-portal/open-application \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"firstName": "<string>",
"lastName": "<string>",
"coverLetterAttachmentId": "<string>",
"email": "jsmith@example.com",
"phoneNumber": "<string>",
"linkedinUrl": "<string>",
"location": {
"street1": "<string>",
"street2": "<string>",
"postalCode": "<string>",
"city": "<string>",
"region": "<string>",
"state": "<string>",
"country": "<string>",
"latitude": 0,
"longitude": 0
},
"cvAttachmentId": "<string>",
"dateOfBirth": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.gospott.com/candidate-portal/open-application"
payload = {
"firstName": "<string>",
"lastName": "<string>",
"coverLetterAttachmentId": "<string>",
"email": "jsmith@example.com",
"phoneNumber": "<string>",
"linkedinUrl": "<string>",
"location": {
"street1": "<string>",
"street2": "<string>",
"postalCode": "<string>",
"city": "<string>",
"region": "<string>",
"state": "<string>",
"country": "<string>",
"latitude": 0,
"longitude": 0
},
"cvAttachmentId": "<string>",
"dateOfBirth": "2023-11-07T05:31:56Z"
}
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({
firstName: '<string>',
lastName: '<string>',
coverLetterAttachmentId: '<string>',
email: 'jsmith@example.com',
phoneNumber: '<string>',
linkedinUrl: '<string>',
location: {
street1: '<string>',
street2: '<string>',
postalCode: '<string>',
city: '<string>',
region: '<string>',
state: '<string>',
country: '<string>',
latitude: 0,
longitude: 0
},
cvAttachmentId: '<string>',
dateOfBirth: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.gospott.com/candidate-portal/open-application', 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/candidate-portal/open-application",
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([
'firstName' => '<string>',
'lastName' => '<string>',
'coverLetterAttachmentId' => '<string>',
'email' => 'jsmith@example.com',
'phoneNumber' => '<string>',
'linkedinUrl' => '<string>',
'location' => [
'street1' => '<string>',
'street2' => '<string>',
'postalCode' => '<string>',
'city' => '<string>',
'region' => '<string>',
'state' => '<string>',
'country' => '<string>',
'latitude' => 0,
'longitude' => 0
],
'cvAttachmentId' => '<string>',
'dateOfBirth' => '2023-11-07T05:31:56Z'
]),
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/candidate-portal/open-application"
payload := strings.NewReader("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"coverLetterAttachmentId\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phoneNumber\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\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\": 0,\n \"longitude\": 0\n },\n \"cvAttachmentId\": \"<string>\",\n \"dateOfBirth\": \"2023-11-07T05:31:56Z\"\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/candidate-portal/open-application")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"coverLetterAttachmentId\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phoneNumber\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\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\": 0,\n \"longitude\": 0\n },\n \"cvAttachmentId\": \"<string>\",\n \"dateOfBirth\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gospott.com/candidate-portal/open-application")
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 \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"coverLetterAttachmentId\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phoneNumber\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\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\": 0,\n \"longitude\": 0\n },\n \"cvAttachmentId\": \"<string>\",\n \"dateOfBirth\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"status": 0,
"message": "Invalid email format",
"requestId": "<string>",
"category": "MALFORMED_REQUEST",
"statusCode": 400,
"error": "Bad Request"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>",
"category": "MALFORMED_REQUEST"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>",
"category": "MALFORMED_REQUEST"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>",
"category": "MALFORMED_REQUEST"
}{
"status": 409,
"category": "RESOURCE_ALREADY_EXISTS",
"message": "Resource already exists",
"requestId": "<string>"
}{
"status": 500,
"category": "INTERNAL_ERROR",
"message": "Internal server error",
"requestId": "<string>"
}Authorizations
API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.
Body
application/json
Required string length:
1 - 100Pattern:
^(?=.*\p{L})[\p{L}\p{M} '’.-]+$Required string length:
1 - 100Pattern:
^(?=.*\p{L})[\p{L}\p{M} '’.-]+$Required string length:
1 - 100Required string length:
3 - 254Pattern:
^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$Phone number in E.164 format
Maximum string length:
2048Show child attributes
Show child attributes
Required string length:
1 - 100Pattern:
^(?:(?:\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))$Response
Application submitted successfully.
Was this page helpful?