Search placements
curl --request POST \
--url https://api.gospott.com/placements/_search \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"filters": [
{
"type": "date",
"value": "2023-11-07T05:31:56Z"
}
],
"searchQuery": "<string>",
"page": 0,
"pageSize": 20
}
'import requests
url = "https://api.gospott.com/placements/_search"
payload = {
"filters": [
{
"type": "date",
"value": "2023-11-07T05:31:56Z"
}
],
"searchQuery": "<string>",
"page": 0,
"pageSize": 20
}
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({
filters: [{type: 'date', value: '2023-11-07T05:31:56Z'}],
searchQuery: '<string>',
page: 0,
pageSize: 20
})
};
fetch('https://api.gospott.com/placements/_search', 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/placements/_search",
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([
'filters' => [
[
'type' => 'date',
'value' => '2023-11-07T05:31:56Z'
]
],
'searchQuery' => '<string>',
'page' => 0,
'pageSize' => 20
]),
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/placements/_search"
payload := strings.NewReader("{\n \"filters\": [\n {\n \"type\": \"date\",\n \"value\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"searchQuery\": \"<string>\",\n \"page\": 0,\n \"pageSize\": 20\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/placements/_search")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filters\": [\n {\n \"type\": \"date\",\n \"value\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"searchQuery\": \"<string>\",\n \"page\": 0,\n \"pageSize\": 20\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gospott.com/placements/_search")
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 \"filters\": [\n {\n \"type\": \"date\",\n \"value\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"searchQuery\": \"<string>\",\n \"page\": 0,\n \"pageSize\": 20\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"id": "<string>",
"templateId": "<string>",
"placedByUser": {
"id": "<string>",
"name": "<string>",
"avatarUrl": "<string>",
"deactivatedAt": "2023-11-07T05:31:56Z"
},
"placedAt": "2023-11-07T05:31:56Z",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"fee": {
"id": "<string>",
"net": {
"amount": 10000,
"currency": "EUR"
},
"splits": [
{
"user": {
"id": "<string>",
"name": "<string>",
"avatarUrl": "<string>",
"deactivatedAt": "2023-11-07T05:31:56Z"
},
"percentage": 0.5
}
],
"details": {}
},
"extensionOf": {
"id": "<string>"
},
"applicationId": "<string>",
"candidate": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"middleName": "<string>",
"secondLastName": "<string>",
"avatarUrl": "<string>"
},
"company": {
"id": "<string>",
"name": "<string>",
"logoCdnUrl": "<string>"
},
"vacancy": {
"id": "<string>",
"name": "<string>"
}
}
],
"pagination": {
"totalItems": 123,
"page": 123,
"hasNextPage": true
}
}{
"status": 0,
"message": "<string>",
"requestId": "<string>"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>"
}Placements
Search placements
Returns a list of placements that match the provided filters. Search placements by filters, sort, and free-text query. Returns candidate, company, job, fee, and placement metadata.
POST
/
placements
/
_search
Search placements
curl --request POST \
--url https://api.gospott.com/placements/_search \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"filters": [
{
"type": "date",
"value": "2023-11-07T05:31:56Z"
}
],
"searchQuery": "<string>",
"page": 0,
"pageSize": 20
}
'import requests
url = "https://api.gospott.com/placements/_search"
payload = {
"filters": [
{
"type": "date",
"value": "2023-11-07T05:31:56Z"
}
],
"searchQuery": "<string>",
"page": 0,
"pageSize": 20
}
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({
filters: [{type: 'date', value: '2023-11-07T05:31:56Z'}],
searchQuery: '<string>',
page: 0,
pageSize: 20
})
};
fetch('https://api.gospott.com/placements/_search', 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/placements/_search",
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([
'filters' => [
[
'type' => 'date',
'value' => '2023-11-07T05:31:56Z'
]
],
'searchQuery' => '<string>',
'page' => 0,
'pageSize' => 20
]),
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/placements/_search"
payload := strings.NewReader("{\n \"filters\": [\n {\n \"type\": \"date\",\n \"value\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"searchQuery\": \"<string>\",\n \"page\": 0,\n \"pageSize\": 20\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/placements/_search")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filters\": [\n {\n \"type\": \"date\",\n \"value\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"searchQuery\": \"<string>\",\n \"page\": 0,\n \"pageSize\": 20\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gospott.com/placements/_search")
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 \"filters\": [\n {\n \"type\": \"date\",\n \"value\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"searchQuery\": \"<string>\",\n \"page\": 0,\n \"pageSize\": 20\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"id": "<string>",
"templateId": "<string>",
"placedByUser": {
"id": "<string>",
"name": "<string>",
"avatarUrl": "<string>",
"deactivatedAt": "2023-11-07T05:31:56Z"
},
"placedAt": "2023-11-07T05:31:56Z",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"fee": {
"id": "<string>",
"net": {
"amount": 10000,
"currency": "EUR"
},
"splits": [
{
"user": {
"id": "<string>",
"name": "<string>",
"avatarUrl": "<string>",
"deactivatedAt": "2023-11-07T05:31:56Z"
},
"percentage": 0.5
}
],
"details": {}
},
"extensionOf": {
"id": "<string>"
},
"applicationId": "<string>",
"candidate": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"middleName": "<string>",
"secondLastName": "<string>",
"avatarUrl": "<string>"
},
"company": {
"id": "<string>",
"name": "<string>",
"logoCdnUrl": "<string>"
},
"vacancy": {
"id": "<string>",
"name": "<string>"
}
}
],
"pagination": {
"totalItems": 123,
"page": 123,
"hasNextPage": true
}
}{
"status": 0,
"message": "<string>",
"requestId": "<string>"
}{
"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
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
- Option 14
- Option 15
- Option 16
- Option 17
- Option 18
- Option 19
- Option 20
- Option 21
- Option 22
- Option 23
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Maximum string length:
100Required range:
0 <= x <= 9007199254740991Required range:
1 <= x <= 100Was this page helpful?
⌘I

