Skip to main content
POST
/
candidates
Create candidate manually
curl --request POST \
  --url https://api.gospott.com/candidates \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "gender": "male",
  "nationality": [
    "Afghan"
  ],
  "status": [
    "actively_looking"
  ],
  "firstName": "<string>",
  "lastName": "<string>",
  "avatarUrl": "<string>",
  "emails": [
    {
      "purpose": "personal",
      "email": "jsmith@example.com"
    }
  ],
  "phoneNumbers": [
    {
      "purpose": "personal",
      "phoneNumber": "<string>"
    }
  ],
  "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": "2023-11-07T05:31:56Z",
  "socialMedia": [
    {
      "url": "<string>",
      "type": "LINKEDIN"
    }
  ],
  "education": [
    {
      "degree": "High School",
      "companyId": "<string>",
      "fieldOfStudy": "<string>",
      "grade": "<string>",
      "description": "<string>",
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z"
    }
  ],
  "workExperiences": [
    {
      "companyId": "<string>",
      "jobTitle": "<string>",
      "location": {
        "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>"
      },
      "description": "<string>",
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z"
    }
  ],
  "customAttributes": [
    {
      "value": "<any>",
      "attributeDefinitionId": "<string>",
      "label": "<string>",
      "description": "<string>",
      "filledByAI": true,
      "options": [
        "<string>"
      ]
    }
  ],
  "mainContact": {
    "userId": "<string>"
  },
  "languages": [
    {
      "id": "clxkq1qyr0000t7t6h1g1g1g1",
      "language": "English",
      "fluency": "Native or bilingual proficiency"
    }
  ],
  "compensation": {
    "id": "<string>",
    "currency": "USD",
    "totalCompensation": 100000,
    "baseCompensation": 80000
  }
}'
"<string>"

Authorizations

x-api-key
string
header
required

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

Body

application/json
firstName
string
required
lastName
string
required
gender
enum<string> | null
Available options:
male,
female
nationality
enum<string>[]
status
enum<string>[]
avatarUrl
string | null
emails
object[]
phoneNumbers
object[]
locations
object[]
dateOfBirth
string<date-time> | null
socialMedia
object[]
education
object[]
workExperiences
object[]
customAttributes
object[]
mainContact
object
languages
object[]
compensation
object

Response

The response is of type string.