Skip to main content
GET
/
candidate-portal
/
{candidateId}
Get existing candidate
curl --request GET \
  --url https://api.gospott.com/candidate-portal/{candidateId} \
  --header 'x-api-key: <api-key>'
{
  "firstName": "<string>",
  "lastName": "<string>",
  "emails": [
    {
      "email": "jsmith@example.com",
      "purpose": "<string>",
      "isPrimary": true
    }
  ],
  "phoneNumbers": [
    {
      "purpose": "personal",
      "phoneNumber": "<string>",
      "isPrimary": true
    }
  ],
  "socialMedia": [
    {
      "url": "<string>",
      "type": "LINKEDIN",
      "isPrimary": 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

candidateId
string
required

Response

200 - application/json
firstName
string
required
lastName
string
required
emails
object[]
required
phoneNumbers
object[]
required
socialMedia
object[]
required