curl --request GET \
--url https://api.gospott.com/opportunities/{id} \
--header 'x-api-key: <api-key>'{
"id": "<string>",
"name": {
"viewType": "opportunityName",
"name": "<string>"
},
"description": {
"viewType": "opportunityDescription",
"description": "<string>"
},
"stage": {
"viewType": "opportunityStage",
"stage": {
"id": "<string>",
"name": "<string>",
"order": 123,
"isOpen": true
}
},
"company": {
"viewType": "opportunityCompany",
"company": {
"id": "<string>",
"name": "<string>"
}
},
"owner": {
"viewType": "opportunityOwner",
"owner": {
"id": "<string>",
"name": "<string>",
"avatarUrl": "<string>",
"deactivatedAt": "2023-11-07T05:31:56Z"
}
},
"closeDate": {
"viewType": "opportunityCloseDate",
"closeDate": {
"target": "2023-11-07T05:31:56Z"
}
},
"createdAt": {
"viewType": "opportunityCreatedAt",
"createdAt": "2023-11-07T05:31:56Z"
},
"clientTeam": {
"viewType": "opportunityClientTeam",
"clientTeam": [
{
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"middleName": "<string>",
"secondLastName": "<string>",
"avatarUrl": "<string>",
"candidateId": "<string>",
"companyId": "<string>",
"companyName": "<string>",
"companyLogoUrl": "<string>",
"jobTitle": "<string>",
"department": "<string>",
"emails": [
{
"purpose": "personal",
"email": "jsmith@example.com",
"isPrimary": true
}
],
"phoneNumbers": [
{
"purpose": "personal",
"phoneNumber": "<string>",
"isPrimary": true
}
]
}
]
},
"nextTaskDue": {
"viewType": "opportunityNextTaskDue",
"nextTaskDue": {
"id": "<string>",
"content": "<string>",
"dueDate": "2023-11-07T05:31:56Z"
}
},
"customAttributes": [
{
"value": {
"viewType": "customText",
"text": "<string>"
},
"attributeDefinitionId": "<string>",
"label": "<string>",
"aiFillOngoing": true,
"aiOverridden": true,
"isFilledByAI": true
}
]
}Retrieve detailed information about a specific opportunity including all custom attributes.
curl --request GET \
--url https://api.gospott.com/opportunities/{id} \
--header 'x-api-key: <api-key>'{
"id": "<string>",
"name": {
"viewType": "opportunityName",
"name": "<string>"
},
"description": {
"viewType": "opportunityDescription",
"description": "<string>"
},
"stage": {
"viewType": "opportunityStage",
"stage": {
"id": "<string>",
"name": "<string>",
"order": 123,
"isOpen": true
}
},
"company": {
"viewType": "opportunityCompany",
"company": {
"id": "<string>",
"name": "<string>"
}
},
"owner": {
"viewType": "opportunityOwner",
"owner": {
"id": "<string>",
"name": "<string>",
"avatarUrl": "<string>",
"deactivatedAt": "2023-11-07T05:31:56Z"
}
},
"closeDate": {
"viewType": "opportunityCloseDate",
"closeDate": {
"target": "2023-11-07T05:31:56Z"
}
},
"createdAt": {
"viewType": "opportunityCreatedAt",
"createdAt": "2023-11-07T05:31:56Z"
},
"clientTeam": {
"viewType": "opportunityClientTeam",
"clientTeam": [
{
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"middleName": "<string>",
"secondLastName": "<string>",
"avatarUrl": "<string>",
"candidateId": "<string>",
"companyId": "<string>",
"companyName": "<string>",
"companyLogoUrl": "<string>",
"jobTitle": "<string>",
"department": "<string>",
"emails": [
{
"purpose": "personal",
"email": "jsmith@example.com",
"isPrimary": true
}
],
"phoneNumbers": [
{
"purpose": "personal",
"phoneNumber": "<string>",
"isPrimary": true
}
]
}
]
},
"nextTaskDue": {
"viewType": "opportunityNextTaskDue",
"nextTaskDue": {
"id": "<string>",
"content": "<string>",
"dueDate": "2023-11-07T05:31:56Z"
}
},
"customAttributes": [
{
"value": {
"viewType": "customText",
"text": "<string>"
},
"attributeDefinitionId": "<string>",
"label": "<string>",
"aiFillOngoing": true,
"aiOverridden": true,
"isFilledByAI": true
}
]
}API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.
Successfully retrieved opportunity details
Unique identifier of the opportunity
The name of the opportunity
Show child attributes
The description of the opportunity
Show child attributes
The current pipeline stage
Show child attributes
The company associated with this opportunity
Show child attributes
The owner of this opportunity
Show child attributes
The target close date
Show child attributes
When the opportunity was created
Show child attributes
Client contacts on this opportunity
Show child attributes
The next task due for this opportunity
Show child attributes
Custom attribute values defined for this opportunity
Show child attributes