Skip to main content
GET
/
search
/
people
Search people
curl --request GET \
  --url https://api.gospott.com/search/people \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "entityType": "candidate",
      "id": "<string>",
      "firstName": "<string>",
      "middleName": "<string>",
      "lastName": "<string>",
      "secondLastName": "<string>",
      "avatarUrl": "<string>",
      "phoneNumbers": [
        "<string>"
      ],
      "emailAddresses": [
        "<string>"
      ],
      "linkedInUrl": "<string>"
    }
  ]
}

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

query
string
required

The search term to find candidates and client contacts. Supports full name, email address, or phone number.

limit
number
default:25

Maximum number of results to return (default: 25)

Response

Successfully retrieved matching people. Returns a list of candidates and client contacts matching the search query.

items
object[]
required