Skip to main content
GET
/
placements
Get placements
curl --request GET \
  --url https://api.gospott.com/placements \
  --header 'x-api-key: <api-key>'
{
  "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",
      "grossFee": {
        "amount": 10000,
        "currency": "EUR"
      },
      "netFee": {
        "amount": 10000,
        "currency": "EUR"
      },
      "applicationId": "<string>",
      "candidate": {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "middleName": "<string>",
        "secondLastName": "<string>",
        "avatarUrl": "<string>"
      },
      "company": {
        "id": "<string>",
        "name": "<string>",
        "logoUrl": "<string>"
      },
      "vacancy": {
        "id": "<string>",
        "name": "<string>"
      },
      "feeSplits": [
        {
          "user": {
            "id": "<string>",
            "name": "<string>",
            "avatarUrl": "<string>",
            "deactivatedAt": "2023-11-07T05:31:56Z"
          },
          "percentage": 0.5
        }
      ]
    }
  ],
  "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.

Query Parameters

page
number
default:0
Required range: 0 <= x <= 10000
pageSize
number
default:20
Required range: 1 <= x <= 100
companyId
string

Filter placements by company ID

appliedSort
object

Sort configuration for the results

appliedFilters
object

Filter configuration for the results

Response

Successfully retrieved placements

items
object[]
required

List of placements for the current page

pagination
object
required

Pagination metadata including total count and navigation info