Skip to main content
POST
/
candidates
Create a candidate
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>",
  "avatarUrl": "<string>",
  "nationality": [],
  "status": [],
  "emails": [
    {
      "email": "jsmith@example.com",
      "isPrimary": true
    }
  ],
  "phoneNumbers": [
    {
      "phoneNumber": "<string>",
      "isPrimary": true
    }
  ],
  "locations": [
    {
      "street1": "<string>",
      "street2": "<string>",
      "postalCode": "<string>",
      "city": "<string>",
      "region": "<string>",
      "state": "<string>",
      "country": "<string>",
      "latitude": 123,
      "longitude": 123
    }
  ],
  "dateOfBirth": "2023-11-07T05:31:56Z",
  "socialMedia": [
    {
      "url": "<string>",
      "isPrimary": true
    }
  ],
  "education": [
    {
      "fieldOfStudy": "<string>",
      "grade": "<string>",
      "description": "<string>",
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "companyId": "<string>"
    }
  ],
  "workExperiences": [
    {
      "jobTitle": "<string>",
      "location": {
        "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",
      "companyId": "<string>"
    }
  ],
  "certifications": [
    {
      "name": "<string>",
      "url": "<string>",
      "issueDate": "2023-11-07T05:31:56Z",
      "expirationDate": "2023-11-07T05:31:56Z",
      "companyId": "<string>"
    }
  ],
  "customAttributes": [
    {
      "attributeDefinitionId": "<string>",
      "value": {
        "text": "<string>"
      }
    }
  ],
  "languages": [
    {
      "id": "<string>"
    }
  ]
}
'
"<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.

Body

application/json
​
firstName
string
required
​
lastName
string
required
​
avatarUrl
string | null
Minimum string length: 1
​
gender
enum<string> | null
Available options:
male,
female,
x
​
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,
approachable_but_not_actively_looking,
do_not_contact,
do_not_poach,
not_actively_looking
​
emails
object[]
​
phoneNumbers
object[]
​
locations
object[]
​
dateOfBirth
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))$
​
socialMedia
object[]
​
education
object[]
​
workExperiences
object[]
​
certifications
object[]
​
customAttributes
object[]
​
mainContact
object
​
languages
object[]
​
compensation
object
​
acquisitionSource
enum<string>
Available options:
juicebox,
pin

Response

Candidate created successfully. Returns the candidate ID.

The response is of type string.