curl --request GET \
--url https://api.gospott.com/clients/{id} \
--header 'x-api-key: <api-key>'{
"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",
"funding": {
"viewType": "clientFunding",
"funding": {
"round": 123,
"lastFundingDate": "2023-11-07T05:31:56Z",
"lastRoundType": "<string>",
"lastRoundAmount": "<string>"
}
},
"contacts": {
"viewType": "clientContacts",
"contacts": [
{
"id": "<string>",
"candidateId": "<string>",
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"avatarUrl": "<string>",
"emailAddresses": [
{
"purpose": "work",
"emailAddress": "jsmith@example.com",
"isPrimary": true
}
],
"phoneNumbers": [
{
"purpose": "work",
"phoneNumber": "<string>",
"isPrimary": true
}
],
"role": "<string>",
"department": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"active": true,
"mainContact": {
"userId": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"avatarUrl": "<string>",
"deactivatedAt": "2023-11-07T05:31:56Z"
},
"stage": {
"id": "<string>",
"order": 123,
"name": "<string>",
"colorHex": "<string>"
},
"customAttributes": [
{
"value": {
"viewType": "customText",
"text": "<string>"
},
"attributeDefinitionId": "<string>",
"label": "<string>",
"aiFillOngoing": true,
"aiOverridden": true,
"isFilledByAI": true
}
]
}
]
},
"isGlobalCompany": true
}Retrieve detailed information about a specific company including company details, contacts, industry, size, funding, locations, and custom attributes.
curl --request GET \
--url https://api.gospott.com/clients/{id} \
--header 'x-api-key: <api-key>'{
"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",
"funding": {
"viewType": "clientFunding",
"funding": {
"round": 123,
"lastFundingDate": "2023-11-07T05:31:56Z",
"lastRoundType": "<string>",
"lastRoundAmount": "<string>"
}
},
"contacts": {
"viewType": "clientContacts",
"contacts": [
{
"id": "<string>",
"candidateId": "<string>",
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"avatarUrl": "<string>",
"emailAddresses": [
{
"purpose": "work",
"emailAddress": "jsmith@example.com",
"isPrimary": true
}
],
"phoneNumbers": [
{
"purpose": "work",
"phoneNumber": "<string>",
"isPrimary": true
}
],
"role": "<string>",
"department": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"active": true,
"mainContact": {
"userId": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"avatarUrl": "<string>",
"deactivatedAt": "2023-11-07T05:31:56Z"
},
"stage": {
"id": "<string>",
"order": 123,
"name": "<string>",
"colorHex": "<string>"
},
"customAttributes": [
{
"value": {
"viewType": "customText",
"text": "<string>"
},
"attributeDefinitionId": "<string>",
"label": "<string>",
"aiFillOngoing": true,
"aiOverridden": true,
"isFilledByAI": true
}
]
}
]
},
"isGlobalCompany": true
}API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.
Successfully retrieved company details
Unique identifier for the client (company ID)
Client status
Show child attributes
Client/company name and avatar
Show child attributes
Company description
Show child attributes
Industry classification
Show child attributes
Company website domain
Show child attributes
LinkedIn company page URL
Show child attributes
Company size (e.g. employee count band)
Show child attributes
Pipeline stage for this client
Show child attributes
Next task due for this client
Show child attributes
Company locations
Show child attributes
Custom attribute values for this client
Show child attributes
Timestamp when the client was created
Timestamp when the client was last modified
Funding information for the company
Show child attributes
Contacts (people) associated with this client
Show child attributes
Whether the company is marked as a global company