Skip to main content
GET
/
placements
/
{placementId}
Get placement
curl --request GET \
  --url https://api.gospott.com/placements/{placementId} \
  --header 'x-api-key: <api-key>'
{
  "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>",
  "attributeValues": [
    {
      "id": "<string>",
      "attributeDefinitionId": "<string>",
      "value": {
        "viewType": "customText",
        "text": "Senior Software Engineer"
      }
    }
  ],
  "feeSplits": [
    {
      "user": {
        "id": "<string>",
        "name": "<string>",
        "avatarUrl": "<string>",
        "deactivatedAt": "2023-11-07T05:31:56Z"
      },
      "percentage": 0.5
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.

Path Parameters

​
placementId
string
required

Response

Successfully retrieved placement details

​
id
string
required

Unique identifier for the placement

​
templateId
string
required

ID of the placement template used. Templates define the custom fields available for this placement.

​
placedByUser
object
required

The user who recorded this placement

​
placedAt
string<date-time>
required

Date when the placement was recorded in the system. This is typically when the offer was accepted.

​
startDate
string<date-time> | null
required

Start date of the placement/employment. Null if not yet determined.

​
endDate
string<date-time> | null
required

End date of the placement/employment. Null for permanent placements or if not yet determined.

​
grossFee
object
required

Gross fee income before deductions. Includes the full placement fee charged to the client.

​
netFee
object
required

Net fee income after deductions. The actual revenue after costs and splits.

​
applicationId
string
required

ID of the application that resulted in this placement. Links the placement to the original candidate application.

​
attributeValues
object[]
required

Custom attribute values associated with this placement. These are organization-specific fields defined in placement templates.

​
feeSplits
object[]
required

Fee splits among team members for this placement. Each split defines a user and their percentage of the fee.