Skip to main content
GET
/
clients
Get clients
curl --request GET \
  --url https://api.gospott.com/clients \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "status": {
        "status": "lead",
        "viewType": "clientStatus"
      },
      "name": {
        "viewType": "clientName",
        "name": "<string>",
        "avatarUrl": "<string>"
      },
      "description": {
        "viewType": "clientDescription",
        "description": "<string>"
      },
      "industry": {
        "industry": "Accessible Architecture and Design",
        "viewType": "clientIndustry"
      },
      "domain": {
        "viewType": "clientDomain",
        "domain": "<string>"
      },
      "linkedinUrl": {
        "viewType": "clientLinkedinUrl",
        "linkedinUrl": "<string>"
      },
      "size": {
        "size": "1 employee",
        "viewType": "clientSize"
      },
      "stage": {
        "viewType": "clientStage",
        "stage": {
          "id": "<string>",
          "order": 123,
          "name": "<string>",
          "colorHex": "<string>"
        }
      },
      "nextTaskDue": {
        "viewType": "clientNextTaskDue",
        "nextTaskDue": {
          "id": "<string>",
          "content": "<string>",
          "dueDate": "2023-11-07T05:31:56Z"
        }
      },
      "locations": {
        "viewType": "clientLocations",
        "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>"
          }
        ]
      },
      "customAttributes": [
        {
          "value": {
            "viewType": "customText",
            "text": "Senior Software Engineer"
          },
          "attributeDefinitionId": "<string>",
          "label": "<string>",
          "aiFillOngoing": true,
          "aiOverridden": true,
          "isFilledByAI": true,
          "options": [
            "<string>"
          ]
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "modifiedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pageInfo": {
    "nextCursor": "<string>",
    "hasNextPage": true
  }
}

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
number

Maximum number of clients to return per page. Must be between 1 and 50. Defaults to 25.

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

25

​
modifiedSince
string<date-time>

ISO 8601 datetime string to filter clients modified on or after this date. Useful for incremental syncing to get only updated records. If omitted, returns all clients from the beginning of time.

Example:

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

​
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.

Response

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

​
items
object[]
required
​
pageInfo
object
required