Skip to main content
GET
/
opportunities
/
{id}
Retrieve an opportunity
curl --request GET \
  --url https://api.gospott.com/opportunities/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "name": {
    "name": "<string>"
  },
  "description": {
    "description": "<string>"
  },
  "stage": {
    "stage": {
      "id": "<string>",
      "name": "<string>",
      "order": 123,
      "isOpen": true
    }
  },
  "company": {
    "company": {
      "id": "<string>",
      "name": "<string>"
    }
  },
  "owner": {
    "owner": {
      "id": "<string>",
      "name": "<string>",
      "avatarUrl": "<string>",
      "deactivatedAt": "2023-11-07T05:31:56Z"
    }
  },
  "closeDate": {
    "closeDate": {
      "target": "2023-11-07T05:31:56Z"
    }
  },
  "createdAt": {
    "createdAt": "2023-11-07T05:31:56Z"
  },
  "clientTeam": {
    "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": [
          {
            "email": "jsmith@example.com",
            "isPrimary": true
          }
        ],
        "phoneNumbers": [
          {
            "phoneNumber": "<string>",
            "isPrimary": true
          }
        ]
      }
    ]
  },
  "nextTaskDue": {
    "nextTaskDue": {
      "id": "<string>",
      "content": "<string>",
      "dueDate": "2023-11-07T05:31:56Z"
    }
  },
  "customAttributes": [
    {
      "attributeDefinitionId": "<string>",
      "label": "<string>",
      "aiFillOngoing": true,
      "aiOverridden": true,
      "isFilledByAI": true,
      "value": {
        "text": "<string>"
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://api-docs.spott.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-api-key
string
header
required

API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.

Path Parameters

id
string
required

Response

Successfully retrieved opportunity details

id
string
required
Minimum string length: 1
name
object
required
description
object
required
stage
object
required
company
object
required
owner
object
required
closeDate
object
required
createdAt
object
required
clientTeam
object
required
nextTaskDue
object
required
customAttributes
object[]
required