Skip to main content
GET
/
candidates
/
{id}
Get candidate by ID
curl --request GET \
  --url https://api.gospott.com/candidates/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "name": {
    "viewType": "candidateName",
    "avatarUrl": "<string>",
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "gender": {
    "viewType": "candidateGender",
    "gender": "male"
  },
  "nationality": {
    "viewType": "candidateNationality",
    "nationality": [
      "Afghan"
    ]
  },
  "status": {
    "viewType": "candidateStatus",
    "status": [
      "actively_looking"
    ]
  },
  "emails": {
    "viewType": "candidateEmails",
    "emails": [
      {
        "purpose": "personal",
        "email": "[email protected]",
        "isPrimary": true
      }
    ]
  },
  "phoneNumbers": {
    "viewType": "candidatePhoneNumbers",
    "phoneNumbers": [
      {
        "purpose": "personal",
        "phoneNumber": "<string>",
        "isPrimary": true
      }
    ]
  },
  "locations": {
    "viewType": "candidateLocation",
    "locations": [
      {
        "type": "primary_home",
        "street1": "<string>",
        "street2": "<string>",
        "postalCode": "<string>",
        "city": "<string>",
        "region": "<string>",
        "state": "<string>",
        "country": "<string>",
        "rawCityCountry": "<string>",
        "latitude": 123,
        "longitude": 123,
        "formattedAddress": "<string>"
      }
    ]
  },
  "dateOfBirth": {
    "viewType": "candidateDateOfBirth",
    "dateOfBirth": "2023-11-07T05:31:56Z"
  },
  "socialMedia": {
    "viewType": "candidateSocialMedia",
    "socialMedia": [
      {
        "url": "<string>",
        "type": "LINKEDIN",
        "isPrimary": true
      }
    ]
  },
  "lastInteractionDate": {
    "viewType": "candidateLastInteractionDate",
    "lastInteractionDate": "2023-11-07T05:31:56Z"
  },
  "lastInteractionWith": {
    "viewType": "candidateLastInteractionWith",
    "user": {
      "userId": "<string>",
      "name": "<string>",
      "email": "<string>",
      "avatarUrl": "<string>",
      "deactivatedAt": "2023-11-07T05:31:56Z"
    }
  },
  "nextInteractionDate": {
    "viewType": "candidateNextInteractionDate",
    "nextInteractionDate": "2023-11-07T05:31:56Z"
  },
  "nextInteractionWith": {
    "viewType": "candidateNextInteractionWith",
    "user": {
      "userId": "<string>",
      "name": "<string>",
      "email": "<string>",
      "avatarUrl": "<string>",
      "deactivatedAt": "2023-11-07T05:31:56Z"
    }
  },
  "mainContact": {
    "viewType": "candidateMainContact",
    "user": {
      "userId": "<string>",
      "name": "<string>",
      "email": "<string>",
      "avatarUrl": "<string>",
      "deactivatedAt": "2023-11-07T05:31:56Z"
    }
  },
  "languages": {
    "viewType": "candidateLanguages",
    "languages": [
      {
        "language": "English",
        "id": "clxkq1qyr0000t7t6h1g1g1g1",
        "fluency": "Native or bilingual proficiency"
      }
    ]
  },
  "compensation": {
    "viewType": "candidateCompensation",
    "compensation": {
      "currency": "USD",
      "id": "<string>",
      "totalCompensation": 100000,
      "baseCompensation": 80000
    }
  },
  "currentPlacements": {
    "viewType": "candidateCurrentPlacements",
    "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": {
    "viewType": "candidateNextTaskDue",
    "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": {
    "viewType": "candidateAcquisitionSource",
    "acquisitionSource": "manual"
  },
  "lastLinkedinDiffAt": "2023-11-07T05:31:56Z",
  "isDiffingLinkedin": true,
  "customAttributes": [
    {
      "value": {
        "viewType": "customImage",
        "imageUrl": "<string>"
      },
      "attributeDefinitionId": "<string>",
      "label": "<string>",
      "description": "<string>",
      "filledByAI": true,
      "options": [
        "<string>"
      ]
    }
  ],
  "aiSummary": "<string>",
  "clientContacts": {
    "viewType": "candidateClientContacts",
    "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": [
          {
            "purpose": "personal",
            "email": "[email protected]",
            "isPrimary": true
          }
        ],
        "phoneNumbers": [
          {
            "purpose": "personal",
            "phoneNumber": "<string>",
            "isPrimary": true
          }
        ],
        "stage": {
          "id": "<string>",
          "order": 123,
          "name": "<string>",
          "colorHex": "<string>"
        },
        "customAttributes": [
          {
            "value": {
              "viewType": "customImage",
              "imageUrl": "<string>"
            },
            "attributeDefinitionId": "<string>",
            "label": "<string>",
            "description": "<string>",
            "filledByAI": true,
            "options": [
              "<string>"
            ]
          }
        ]
      }
    ]
  },
  "isVisibleIfClientContact": true,
  "hasClientContacts": true,
  "hasActiveClientContacts": true
}

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
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
string<date-time>
required
modifiedAt
string<date-time>
required
lastActivityDate
string<date-time>
required
acquisitionSource
object
required
lastLinkedinDiffAt
string<date-time> | null
required
isDiffingLinkedin
boolean
required
customAttributes
object[]
required
aiSummary
string | null
required
clientContacts
object
required
isVisibleIfClientContact
boolean | null
required
hasClientContacts
boolean | null
required
hasActiveClientContacts
boolean | null
required