curl --request GET \
--url https://api.gospott.com/clients/contacts/{candidateId} \
--header 'x-api-key: <api-key>'{
"clientContacts": [
{
"emailAddresses": [
{
"purpose": "personal",
"email": "jsmith@example.com",
"isPrimary": true
}
],
"phoneNumbers": [
{
"purpose": "personal",
"phoneNumber": "<string>",
"isPrimary": true
}
],
"id": "<string>",
"company": {
"id": "<string>",
"name": "<string>",
"logoUrl": "<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>"
},
"customAttributes": [
{
"value": {
"viewType": "customText",
"text": "<string>"
},
"attributeDefinitionId": "<string>",
"label": "<string>",
"aiFillOngoing": true,
"aiOverridden": true,
"isFilledByAI": true
}
]
}
],
"candidateId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"avatarUrl": "<string>",
"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>"
}
],
"lastInteractionDate": "2023-11-07T05:31:56Z",
"lastInteractionWith": {
"id": "<string>",
"name": "<string>",
"avatarUrl": "<string>",
"deactivatedAt": "2023-11-07T05:31:56Z"
},
"nextInteractionDate": "2023-11-07T05:31:56Z",
"nextInteractionWith": {
"id": "<string>",
"name": "<string>",
"avatarUrl": "<string>",
"deactivatedAt": "2023-11-07T05:31:56Z"
},
"lastActivityDate": "2023-11-07T05:31:56Z",
"nextTaskDue": {
"id": "<string>",
"content": "<string>",
"dueDate": "2023-11-07T05:31:56Z"
},
"mainContact": {
"userId": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"avatarUrl": "<string>",
"deactivatedAt": "2023-11-07T05:31:56Z"
}
}Retrieve detailed information about a Contact including their personal details, company associations, contact information, interaction history, and custom attributes.
curl --request GET \
--url https://api.gospott.com/clients/contacts/{candidateId} \
--header 'x-api-key: <api-key>'{
"clientContacts": [
{
"emailAddresses": [
{
"purpose": "personal",
"email": "jsmith@example.com",
"isPrimary": true
}
],
"phoneNumbers": [
{
"purpose": "personal",
"phoneNumber": "<string>",
"isPrimary": true
}
],
"id": "<string>",
"company": {
"id": "<string>",
"name": "<string>",
"logoUrl": "<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>"
},
"customAttributes": [
{
"value": {
"viewType": "customText",
"text": "<string>"
},
"attributeDefinitionId": "<string>",
"label": "<string>",
"aiFillOngoing": true,
"aiOverridden": true,
"isFilledByAI": true
}
]
}
],
"candidateId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"avatarUrl": "<string>",
"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>"
}
],
"lastInteractionDate": "2023-11-07T05:31:56Z",
"lastInteractionWith": {
"id": "<string>",
"name": "<string>",
"avatarUrl": "<string>",
"deactivatedAt": "2023-11-07T05:31:56Z"
},
"nextInteractionDate": "2023-11-07T05:31:56Z",
"nextInteractionWith": {
"id": "<string>",
"name": "<string>",
"avatarUrl": "<string>",
"deactivatedAt": "2023-11-07T05:31:56Z"
},
"lastActivityDate": "2023-11-07T05:31:56Z",
"nextTaskDue": {
"id": "<string>",
"content": "<string>",
"dueDate": "2023-11-07T05:31:56Z"
},
"mainContact": {
"userId": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"avatarUrl": "<string>",
"deactivatedAt": "2023-11-07T05:31:56Z"
}
}API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.
Successfully retrieved Contact overview
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes