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 '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "gender": "male",
  "nationality": [
    "Afghan"
  ],
  "status": [
    "actively_looking"
  ],
  "acquisitionSource": "juicebox",
  "avatarUrl": "<string>",
  "emails": [
    {
      "purpose": "personal",
      "email": "[email protected]",
      "isPrimary": true
    }
  ],
  "phoneNumbers": [
    {
      "purpose": "personal",
      "phoneNumber": "<string>",
      "isPrimary": true
    }
  ],
  "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",
      "isPrimary": true
    }
  ],
  "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": {
        "viewType": "customImage",
        "imageUrl": "<string>"
      },
      "attributeDefinitionId": "<string>",
      "label": "<string>",
      "description": "<string>",
      "filledByAI": true,
      "options": [
        "<string>"
      ]
    }
  ],
  "mainContact": {
    "userId": "<string>"
  },
  "languages": [
    {
      "language": "English",
      "id": "clxkq1qyr0000t7t6h1g1g1g1",
      "fluency": "Native or bilingual proficiency"
    }
  ],
  "compensation": {
    "currency": "USD",
    "id": "<string>",
    "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>[]
Available options:
Afghan,
Albanian,
Algerian,
American,
Andorran,
Angolan,
Antiguan,
Argentinean,
Armenian,
Australian,
Austrian,
Azerbaijani,
Bahamian,
Bahraini,
Bangladeshi,
Barbadian,
Barbudan,
Batswana,
Belarusian,
Belgian,
Belizean,
Beninese,
Bhutanese,
Bolivian,
Bosnian,
Brazilian,
British,
Bruneian,
Bulgarian,
Burkinabe,
Burmese,
Burundian,
Cambodian,
Cameroonian,
Canadian,
Cape Verdean,
Central African,
Chadian,
Chilean,
Chinese,
Colombian,
Comoran,
Congolese,
Costa Rican,
Croatian,
Cuban,
Cypriot,
Czech,
Danish,
Djibouti,
Dominican,
Dutch,
East Timorese,
Ecuadorean,
Egyptian,
Emirian,
Equatorial Guinean,
Eritrean,
Estonian,
Ethiopian,
Fijian,
Filipino,
Finnish,
French,
Gabonese,
Gambian,
Georgian,
German,
Ghanaian,
Greek,
Grenadian,
Guatemalan,
Guinea-Bissauan,
Guinean,
Guyanese,
Haitian,
Herzegovinian,
Honduran,
Hungarian,
I-Kiribati,
Icelander,
Indian,
Indonesian,
Iranian,
Iraqi,
Irish,
Israeli,
Italian,
Ivorian,
Jamaican,
Japanese,
Jordanian,
Kazakhstani,
Kenyan,
Kittian and Nevisian,
Kuwaiti,
Kyrgyz,
Laotian,
Latvian,
Lebanese,
Liberian,
Libyan,
Liechtensteiner,
Lithuanian,
Luxembourger,
Macedonian,
Malagasy,
Malawian,
Malaysian,
Maldivian,
Malian,
Maltese,
Marshallese,
Mauritanian,
Mauritian,
Mexican,
Micronesian,
Moldovan,
Monacan,
Mongolian,
Moroccan,
Mosotho,
Motswana,
Mozambican,
Namibian,
Nauruan,
Nepalese,
New Zealander,
Ni-Vanuatu,
Nicaraguan,
Nigerian,
Nigerien,
North Korean,
Northern Irish,
Norwegian,
Omani,
Pakistani,
Palauan,
Panamanian,
Papua New Guinean,
Paraguayan,
Peruvian,
Polish,
Portuguese,
Qatari,
Romanian,
Russian,
Rwandan,
Saint Lucian,
Salvadoran,
Samoan,
San Marinese,
Sao Tomean,
Saudi,
Scottish,
Senegalese,
Serbian,
Seychellois,
Sierra Leonean,
Singaporean,
Slovakian,
Slovenian,
Solomon Islander,
Somali,
South African,
South Korean,
Spanish,
Sri Lankan,
Sudanese,
Surinamer,
Swazi,
Swedish,
Swiss,
Syrian,
Taiwanese,
Tajik,
Tanzanian,
Thai,
Togolese,
Tongan,
Trinidadian or Tobagonian,
Tunisian,
Turkish,
Tuvaluan,
Ugandan,
Ukrainian,
Uruguayan,
Uzbekistani,
Venezuelan,
Vietnamese,
Welsh,
Yemenite,
Zambian,
Zimbabwean
​
status
enum<string>[]
Available options:
actively_looking,
do_not_contact,
do_not_poach,
not_actively_looking
​
acquisitionSource
enum<string>
Available options:
juicebox
​
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.