Skip to main content
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
}
'
{
  "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
  }
}

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
filters
object[]
sort
object
searchQuery
string
Maximum string length: 100
page
integer
default:0
Required range: 0 <= x <= 9007199254740991
pageSize
integer
default:20
Required range: 1 <= x <= 100

Response

Successfully searched placements. Returns items array with pagination info containing page number, page size, and total count.

items
object[]
required
pagination
object
required