Skip to main content
GET
/
clients
/
contacts
Get client contacts
curl --request GET \
  --url https://api.gospott.com/clients/contacts \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "candidateId": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "avatarUrl": "<string>",
      "locations": [
        {
          "street1": "<string>",
          "street2": "<string>",
          "postalCode": "<string>",
          "city": "<string>",
          "region": "<string>",
          "state": "<string>",
          "country": "<string>",
          "rawCityCountry": "<string>",
          "latitude": 123,
          "longitude": 123,
          "formattedAddress": "<string>"
        }
      ],
      "client": {
        "company": {
          "id": "<string>",
          "name": "<string>",
          "logoUrl": "<string>",
          "linkedinUrl": "<string>"
        },
        "locations": [
          {
            "street1": "<string>",
            "street2": "<string>",
            "postalCode": "<string>",
            "city": "<string>",
            "region": "<string>",
            "state": "<string>",
            "country": "<string>",
            "rawCityCountry": "<string>",
            "latitude": 123,
            "longitude": 123,
            "formattedAddress": "<string>"
          }
        ]
      },
      "role": "<string>",
      "department": "<string>",
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "active": true,
      "stage": {
        "id": "<string>",
        "order": 123,
        "name": "<string>",
        "colorHex": "<string>"
      },
      "mainContact": {
        "id": "<string>",
        "name": "<string>",
        "avatarUrl": "<string>",
        "deactivatedAt": "2023-11-07T05:31:56Z"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "customAttributes": [
        {
          "attributeDefinitionId": "<string>",
          "label": "<string>",
          "aiFillOngoing": true,
          "aiOverridden": true,
          "isFilledByAI": true,
          "value": {
            "text": "<string>"
          }
        }
      ],
      "modifiedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "cursor": "<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.

Query Parameters

​
limit
integer
default:25

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

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

25

​
cursor
string

Opaque cursor string for pagination. Use the cursor value from a previous response to fetch the next page. Omit for the first page.

Example:

"eyJtb2RpZmllZEF0IjoiMjAyNC0xMS0wNlQxMDozMDowMC4wMDBaIiwiaWQiOiJjbGllbnQtY29udGFjdC0xMjMifQ.signature"

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

Filter client contacts 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 client contacts 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"

Response

Successfully retrieved client contacts. Returns items with pagination metadata containing the cursor for the next page.

​
items
object[]
required
​
pagination
object
required