Skip to main content
GET
/
candidates
/
{id}
Retrieve a candidate
curl --request GET \
  --url https://api.gospott.com/candidates/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "name": {
    "avatarUrl": "<string>",
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "gender": {},
  "nationality": {
    "nationality": []
  },
  "status": {
    "status": []
  },
  "emails": {
    "emails": [
      {
        "email": "<string>",
        "isPrimary": true
      }
    ]
  },
  "phoneNumbers": {
    "phoneNumbers": [
      {
        "phoneNumber": "<string>",
        "isPrimary": true
      }
    ]
  },
  "locations": {
    "locations": [
      {
        "street1": "<string>",
        "street2": "<string>",
        "postalCode": "<string>",
        "city": "<string>",
        "region": "<string>",
        "state": "<string>",
        "country": "<string>",
        "rawCityCountry": "<string>",
        "latitude": 123,
        "longitude": 123,
        "formattedAddress": "<string>"
      }
    ]
  },
  "dateOfBirth": {
    "dateOfBirth": "2023-11-07T05:31:56Z"
  },
  "socialMedia": {
    "socialMedia": [
      {
        "url": "<string>",
        "isPrimary": true
      }
    ]
  },
  "lastInteractionDate": {
    "lastInteractionDate": "2023-11-07T05:31:56Z"
  },
  "lastInteractionWith": {
    "user": {
      "userId": "<string>",
      "name": "<string>",
      "email": "jsmith@example.com",
      "avatarUrl": "<string>",
      "deactivatedAt": "2023-11-07T05:31:56Z"
    }
  },
  "nextInteractionDate": {
    "nextInteractionDate": "2023-11-07T05:31:56Z"
  },
  "nextInteractionWith": {
    "user": {
      "userId": "<string>",
      "name": "<string>",
      "email": "jsmith@example.com",
      "avatarUrl": "<string>",
      "deactivatedAt": "2023-11-07T05:31:56Z"
    }
  },
  "mainContact": {
    "user": {
      "userId": "<string>",
      "name": "<string>",
      "email": "jsmith@example.com",
      "avatarUrl": "<string>",
      "deactivatedAt": "2023-11-07T05:31:56Z"
    }
  },
  "languages": {
    "languages": [
      {
        "id": "<string>"
      }
    ]
  },
  "compensation": {
    "compensation": {
      "id": "<string>",
      "totalCompensation": 123,
      "baseCompensation": 123
    }
  },
  "currentPlacements": {
    "hasCurrentPlacement": true,
    "placements": [
      {
        "id": "<string>",
        "company": {
          "id": "<string>",
          "name": "<string>",
          "logoUrl": "<string>"
        },
        "startDate": "2023-11-07T05:31:56Z",
        "endDate": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "nextTaskDue": {
    "nextTaskDue": {
      "id": "<string>",
      "content": "<string>",
      "dueDate": "2023-11-07T05:31:56Z"
    }
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "modifiedAt": "2023-11-07T05:31:56Z",
  "lastActivityDate": "2023-11-07T05:31:56Z",
  "acquisitionSource": {},
  "latestWorkExperience": {
    "title": "<string>",
    "company": {
      "id": "<string>",
      "name": "<string>",
      "logoUrl": "<string>"
    }
  },
  "customAttributes": [
    {
      "attributeDefinitionId": "<string>",
      "label": "<string>",
      "aiFillOngoing": true,
      "aiOverridden": true,
      "isFilledByAI": true,
      "value": {
        "text": "<string>"
      }
    }
  ],
  "aiSummary": "<string>",
  "clientContacts": {
    "clientContacts": [
      {
        "id": "<string>",
        "company": {
          "id": "<string>",
          "name": "<string>",
          "logoUrl": "<string>"
        },
        "role": "<string>",
        "department": "<string>",
        "startDate": "2023-11-07T05:31:56Z",
        "endDate": "2023-11-07T05:31:56Z",
        "active": true,
        "emailAddresses": [
          {
            "email": "<string>",
            "isPrimary": true
          }
        ],
        "phoneNumbers": [
          {
            "phoneNumber": "<string>",
            "isPrimary": true
          }
        ],
        "stage": {
          "id": "<string>",
          "order": 123,
          "name": "<string>",
          "colorHex": "<string>"
        },
        "customAttributes": [
          {
            "attributeDefinitionId": "<string>",
            "label": "<string>",
            "aiFillOngoing": true,
            "aiOverridden": true,
            "isFilledByAI": true,
            "value": {
              "text": "<string>"
            }
          }
        ]
      }
    ]
  },
  "isVisibleIfClientContact": true,
  "hasClientContacts": true,
  "hasActiveClientContacts": true,
  "skills": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://api-docs.spott.io/llms.txt

Use this file to discover all available pages before exploring further.

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

​
id
string
required

Response

Successfully retrieved candidate details

​
id
string
required
Minimum string length: 1
​
name
object
required
​
gender
object
required
​
nationality
object
required
​
status
object
required
​
emails
object
required
​
phoneNumbers
object
required
​
locations
object
required
​
dateOfBirth
object
required
​
socialMedia
object
required
​
lastInteractionDate
object
required
​
lastInteractionWith
object
required
​
nextInteractionDate
object
required
​
nextInteractionWith
object
required
​
mainContact
object
required
​
languages
object
required
​
compensation
object
required
​
currentPlacements
object
required
​
nextTaskDue
object
required
​
createdAt
required
Pattern: ^(?:(?:\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))$
​
modifiedAt
required
Pattern: ^(?:(?:\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))$
​
lastActivityDate
required
Pattern: ^(?:(?:\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))$
​
acquisitionSource
object
required
​
latestWorkExperience
object
required
​
customAttributes
object[]
required
​
aiSummary
string | null
required
​
clientContacts
object
required
​
isVisibleIfClientContact
boolean | null
required
​
hasClientContacts
boolean | null
required
​
hasActiveClientContacts
boolean | null
required
​
skills
object[]