Skip to main content
GET
/
candidates
List candidates
curl --request GET \
  --url https://api.gospott.com/candidates \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "name": {
        "avatarUrl": "<string>",
        "firstName": "<string>",
        "lastName": "<string>"
      },
      "gender": {},
      "nationality": {
        "nationality": []
      },
      "status": {
        "status": []
      },
      "emails": {
        "emails": [
          {
            "email": "<string>",
            "isPrimary": true
          }
        ]
      },
      "phoneNumbers": {
        "phoneNumbers": [
          {
            "phoneNumber": "<string>",
            "isPrimary": true
          }
        ]
      },
      "locations": {
        "locations": [
          {
            "street1": "<string>",
            "street2": "<string>",
            "postalCode": "<string>",
            "city": "<string>",
            "region": "<string>",
            "state": "<string>",
            "country": "<string>",
            "rawCityCountry": "<string>",
            "latitude": 123,
            "longitude": 123,
            "formattedAddress": "<string>"
          }
        ]
      },
      "dateOfBirth": {
        "dateOfBirth": "2023-11-07T05:31:56Z"
      },
      "socialMedia": {
        "socialMedia": [
          {
            "url": "<string>",
            "isPrimary": true
          }
        ]
      },
      "lastInteractionDate": {
        "lastInteractionDate": "2023-11-07T05:31:56Z"
      },
      "lastInteractionWith": {
        "user": {
          "userId": "<string>",
          "name": "<string>",
          "email": "jsmith@example.com",
          "avatarUrl": "<string>",
          "deactivatedAt": "2023-11-07T05:31:56Z"
        }
      },
      "nextInteractionDate": {
        "nextInteractionDate": "2023-11-07T05:31:56Z"
      },
      "nextInteractionWith": {
        "user": {
          "userId": "<string>",
          "name": "<string>",
          "email": "jsmith@example.com",
          "avatarUrl": "<string>",
          "deactivatedAt": "2023-11-07T05:31:56Z"
        }
      },
      "mainContact": {
        "user": {
          "userId": "<string>",
          "name": "<string>",
          "email": "jsmith@example.com",
          "avatarUrl": "<string>",
          "deactivatedAt": "2023-11-07T05:31:56Z"
        }
      },
      "languages": {
        "languages": [
          {
            "id": "<string>"
          }
        ]
      },
      "compensation": {
        "compensation": {
          "id": "<string>",
          "totalCompensation": 123,
          "baseCompensation": 123
        }
      },
      "currentPlacements": {
        "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": {
        "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": {},
      "latestWorkExperience": {
        "title": "<string>",
        "company": {
          "id": "<string>",
          "name": "<string>",
          "logoUrl": "<string>"
        }
      },
      "customAttributes": [
        {
          "attributeDefinitionId": "<string>",
          "label": "<string>",
          "aiFillOngoing": true,
          "aiOverridden": true,
          "isFilledByAI": true,
          "value": {
            "text": "<string>"
          }
        }
      ],
      "aiSummary": "<string>",
      "skills": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ]
    }
  ],
  "pageInfo": {
    "nextCursor": "<string>",
    "hasNextPage": true
  }
}

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.

Query Parameters

​
limit
integer
default:25

Number of candidates to return per page (min: 1, max: 50, default: 25).

Required range: 1 <= x <= 50
Example:

25

​
cursor
string

Base64-encoded cursor for pagination. Use the nextCursor value from a previous response to fetch the next page. Omit for the first page.

Example:

"eyJtb2RpZmllZEF0IjoiMjAyNC0xMS0wNlQxMDozMDowMC4wMDBaIiwiaWQiOiJjYW5kaWRhdGUtMTIzIn0="

​
modifiedSince
default:1970-01-01T00:00:00.000Z

Filter candidates by sync watermark on or after this date. Useful for incremental synchronization. Defaults to beginning of time if not provided.

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))$
Example:

"2024-11-01T00:00:00.000Z"

​
modifiedUntil

Filter candidates by sync watermark on or before this date. Useful for bounded synchronization snapshots. If omitted, no upper bound is applied.

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))$
Example:

"2024-11-30T23:59:59.999Z"

​
include
string[]
required

Optional related resources to include in the response. Allowed values: skills.

Example:
["skills"]

Response

Successfully retrieved candidates. Returns items array with pagination info containing cursor for the next page.

​
items
object[]
required
​
pageInfo
object
required