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": "<string>"
},
"attributeDefinitionId": "<string>",
"label": "<string>",
"aiFillOngoing": true,
"aiOverridden": true,
"isFilledByAI": true
}
],
"createdAt": "2023-11-07T05:31:56Z",
"modifiedAt": "2023-11-07T05:31:56Z"
}
],
"pageInfo": {
"nextCursor": "<string>",
"hasNextPage": true
}
}Return a list of 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": "<string>"
},
"attributeDefinitionId": "<string>",
"label": "<string>",
"aiFillOngoing": true,
"aiOverridden": true,
"isFilledByAI": true
}
],
"createdAt": "2023-11-07T05:31:56Z",
"modifiedAt": "2023-11-07T05:31:56Z"
}
],
"pageInfo": {
"nextCursor": "<string>",
"hasNextPage": true
}
}API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.
Maximum number of clients to return per page. Must be between 1 and 50. Defaults to 25.
1 <= x <= 5025
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.
"2024-01-01T00:00:00.000Z"
Cursor for pagination. Use the nextCursor value from a previous response to fetch the next page. Omit for the first page.