> ## 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. # Retrieve an opportunity > Retrieves the opportunity with the specified ID. Includes all custom attributes. ## OpenAPI ````yaml /openapi-private.json get /opportunities/{id} openapi: 3.1.0 info: title: Spott API Reference version: '0.1' servers: - url: https://api.gospott.com security: [] tags: [] paths: /opportunities/{id}: get: tags: - Opportunities summary: Retrieve an opportunity description: >- Retrieves the opportunity with the specified ID. Includes all custom attributes. operationId: getOpportunityById parameters: - name: id required: true in: path schema: type: string responses: '200': description: Successfully retrieved opportunity details content: application/json: schema: $ref: '#/components/schemas/OpportunityDto' '400': description: Bad Request content: application/json: schema: oneOf: - $ref: '#/components/schemas/ValidationExceptionDto' - $ref: '#/components/schemas/ExceptionBaseDto' '401': description: Unauthorized - invalid or missing authentication content: application/json: schema: $ref: '#/components/schemas/ExceptionBaseDto' '404': description: Opportunity not found content: application/json: schema: allOf: - $ref: '#/components/schemas/ExceptionBaseDto' - type: object properties: statusCode: type: number example: 404 message: type: string example: Opportunity not found error: type: string example: Not Found '500': description: Error response content: application/json: schema: $ref: '#/components/schemas/ExceptionBaseDto' security: - x-api-key: [] components: schemas: OpportunityDto: type: object properties: id: type: string minLength: 1 name: $ref: '#/components/schemas/OpportunityNameTypeDto' description: $ref: '#/components/schemas/OpportunityDescriptionTypeDto' stage: $ref: '#/components/schemas/OpportunityStageTypeDto' company: $ref: '#/components/schemas/OpportunityCompanyTypeDto' owner: $ref: '#/components/schemas/OpportunityOwnerTypeDto' closeDate: $ref: '#/components/schemas/OpportunityCloseDateTypeDto' createdAt: $ref: '#/components/schemas/OpportunityCreatedAtTypeDto' clientTeam: $ref: '#/components/schemas/OpportunityClientTeamTypeDto' nextTaskDue: $ref: '#/components/schemas/OpportunityNextTaskDueTypeDto' locations: $ref: '#/components/schemas/OpportunityLocationsTypeDto' customAttributes: type: array items: $ref: '#/components/schemas/CustomAttributeItemDto' required: - id - name - description - stage - company - owner - closeDate - createdAt - clientTeam - nextTaskDue - locations - customAttributes id: PrivateOpportunityDto ValidationExceptionDto: type: object properties: status: type: integer minimum: -9007199254740991 maximum: 9007199254740991 message: type: string requestId: type: string errors: type: array items: $ref: '#/components/schemas/ValidationIssueDto' required: - status - message - requestId - errors id: ValidationExceptionDto ExceptionBaseDto: type: object properties: status: type: integer minimum: -9007199254740991 maximum: 9007199254740991 message: type: string requestId: type: string required: - status - message - requestId id: ExceptionBaseDto OpportunityNameTypeDto: type: object properties: viewType: type: string enum: - opportunityName name: type: string required: - viewType - name id: PrivateOpportunityNameTypeDto OpportunityDescriptionTypeDto: type: object properties: viewType: type: string enum: - opportunityDescription description: anyOf: - type: string - type: 'null' required: - viewType - description id: PrivateOpportunityDescriptionTypeDto OpportunityStageTypeDto: type: object properties: viewType: type: string enum: - opportunityStage stage: $ref: '#/components/schemas/OpportunityStageValueDto' required: - viewType - stage id: PrivateOpportunityStageTypeDto OpportunityCompanyTypeDto: type: object properties: viewType: type: string enum: - opportunityCompany company: $ref: '#/components/schemas/OpportunityCompanyValueDto' required: - viewType - company id: PrivateOpportunityCompanyTypeDto OpportunityOwnerTypeDto: type: object properties: viewType: type: string enum: - opportunityOwner owner: anyOf: - $ref: '#/components/schemas/UserBadgeDto' - type: 'null' required: - viewType - owner id: PrivateOpportunityOwnerTypeDto OpportunityCloseDateTypeDto: type: object properties: viewType: type: string enum: - opportunityCloseDate closeDate: $ref: '#/components/schemas/OpportunityCloseDateValueDto' required: - viewType - closeDate id: PrivateOpportunityCloseDateTypeDto OpportunityCreatedAtTypeDto: type: object properties: viewType: type: string enum: - opportunityCreatedAt createdAt: $ref: '#/components/schemas/DateISO' required: - viewType - createdAt id: PrivateOpportunityCreatedAtTypeDto OpportunityClientTeamTypeDto: type: object properties: viewType: type: string enum: - opportunityClientTeam clientTeam: type: array items: type: object properties: id: type: string minLength: 1 firstName: type: string lastName: type: string middleName: anyOf: - type: string - type: 'null' secondLastName: anyOf: - type: string - type: 'null' avatarUrl: anyOf: - type: string - type: 'null' candidateId: type: string minLength: 1 companyId: type: string minLength: 1 companyName: type: string companyLogoUrl: anyOf: - type: string - type: 'null' jobTitle: anyOf: - type: string - type: 'null' department: anyOf: - type: string - type: 'null' emails: type: array items: type: object properties: email: type: string format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ purpose: anyOf: - type: string enum: - personal - work - type: 'null' isPrimary: type: boolean required: - email - purpose - isPrimary phoneNumbers: type: array items: type: object properties: phoneNumber: type: string purpose: anyOf: - type: string enum: - personal - work - type: 'null' isPrimary: type: boolean required: - phoneNumber - purpose - isPrimary required: - id - firstName - lastName - middleName - secondLastName - avatarUrl - candidateId - companyId - companyName - companyLogoUrl - jobTitle - department - emails - phoneNumbers required: - viewType - clientTeam id: PrivateOpportunityClientTeamTypeDto OpportunityNextTaskDueTypeDto: type: object properties: viewType: type: string enum: - opportunityNextTaskDue nextTaskDue: anyOf: - type: object properties: id: type: string minLength: 1 content: type: string dueDate: anyOf: - $ref: '#/components/schemas/DateISO' - type: 'null' required: - id - content - dueDate - type: 'null' required: - viewType - nextTaskDue id: PrivateOpportunityNextTaskDueTypeDto OpportunityLocationsTypeDto: type: object properties: viewType: type: string enum: - opportunityLocations locations: type: array items: $ref: '#/components/schemas/LocationDto' required: - viewType - locations id: PrivateOpportunityLocationsTypeDto CustomAttributeItemDto: type: object properties: attributeDefinitionId: type: string minLength: 1 label: type: string aiFillOngoing: type: boolean aiOverridden: type: boolean isFilledByAI: type: boolean value: $ref: '#/components/schemas/SharedCustomAttributeTypeDto' required: - attributeDefinitionId - label - aiFillOngoing - aiOverridden - isFilledByAI - value id: PrivateCustomAttributeItemDto ValidationIssueDto: oneOf: - $ref: '#/components/schemas/ValidationRequiredDto' - $ref: '#/components/schemas/ValidationInvalidEmptyStringDto' - $ref: '#/components/schemas/ValidationUnknownFieldDto' - $ref: '#/components/schemas/ValidationTooSmallDto' - $ref: '#/components/schemas/ValidationTooBigDto' - $ref: '#/components/schemas/ValidationInvalidTypeDto' - $ref: '#/components/schemas/ValidationInvalidValueDto' - $ref: '#/components/schemas/ValidationInvalidEmailDto' - $ref: '#/components/schemas/ValidationInvalidUuidDto' - $ref: '#/components/schemas/ValidationInvalidUrlDto' - $ref: '#/components/schemas/ValidationInvalidDatetimeDto' - $ref: '#/components/schemas/ValidationInvalidDateDto' - $ref: '#/components/schemas/ValidationInvalidTimeDto' - $ref: '#/components/schemas/ValidationInvalidDurationDto' - $ref: '#/components/schemas/ValidationInvalidIpv4Dto' - $ref: '#/components/schemas/ValidationInvalidIpv6Dto' - $ref: '#/components/schemas/ValidationInvalidJsonStringDto' - $ref: '#/components/schemas/ValidationInvalidJwtDto' - $ref: '#/components/schemas/ValidationInvalidRegexDto' - $ref: '#/components/schemas/ValidationInvalidPhoneNumberDto' - $ref: '#/components/schemas/ValidationInvalidDomainDto' - $ref: '#/components/schemas/ValidationInvalidHttpsUrlDto' - $ref: '#/components/schemas/ValidationInvalidTimezoneDto' - $ref: '#/components/schemas/ValidationPaginationOffsetExceededDto' id: ValidationIssueDto OpportunityStageValueDto: type: object properties: id: type: string minLength: 1 name: type: string order: type: number isOpen: type: boolean required: - id - name - order - isOpen id: PrivateOpportunityStageValueDto OpportunityCompanyValueDto: type: object properties: id: type: string minLength: 1 name: type: string required: - id - name id: PrivateOpportunityCompanyValueDto UserBadgeDto: type: object properties: id: type: string name: type: string avatarUrl: anyOf: - type: string - type: 'null' deactivatedAt: anyOf: - $ref: '#/components/schemas/DateISO' - type: 'null' required: - id - name - avatarUrl - deactivatedAt id: PrivateUserBadgeDto OpportunityCloseDateValueDto: type: object properties: target: anyOf: - $ref: '#/components/schemas/DateISO' - type: 'null' required: - target id: PrivateOpportunityCloseDateValueDto DateISO: id: DateISO format: date-time anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ - type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ LocationDto: type: object properties: street1: anyOf: - type: string - type: 'null' street2: anyOf: - type: string - type: 'null' postalCode: anyOf: - type: string - type: 'null' city: anyOf: - type: string - type: 'null' region: anyOf: - type: string - type: 'null' state: anyOf: - type: string - type: 'null' country: anyOf: - type: string - type: 'null' rawCityCountry: anyOf: - type: string - type: 'null' latitude: anyOf: - type: number - type: 'null' longitude: anyOf: - type: number - type: 'null' formattedAddress: anyOf: - type: string - type: 'null' type: anyOf: - $ref: '#/components/schemas/LocationType' - type: 'null' required: - street1 - street2 - postalCode - city - region - state - country - rawCityCountry - latitude - longitude - formattedAddress - type id: PrivateLocationDto SharedCustomAttributeTypeDto: oneOf: - $ref: '#/components/schemas/CustomTextTypeDto' - $ref: '#/components/schemas/CustomNumberTypeDto' - $ref: '#/components/schemas/CustomCheckboxTypeDto' - $ref: '#/components/schemas/CustomDateTypeDto' - $ref: '#/components/schemas/CustomTimestampTypeDto' - $ref: '#/components/schemas/CustomRatingTypeDto' - $ref: '#/components/schemas/CustomSelectTypeDto' - $ref: '#/components/schemas/CustomMultiSelectTypeDto' - $ref: '#/components/schemas/CustomCurrencyTypeDto' - $ref: '#/components/schemas/CustomDateRangeTypeDto' - $ref: '#/components/schemas/CustomDurationTypeDto' - $ref: '#/components/schemas/CustomUrlTypeDto' - $ref: '#/components/schemas/CustomEntityTypeDto' - $ref: '#/components/schemas/CustomMultiEntityTypeDto' id: SharedPrivateCustomAttributeTypeDto ValidationRequiredDto: type: object properties: code: type: string enum: - REQUIRED path: type: string message: type: string received: {} required: - code - path - message id: ValidationRequiredDto ValidationInvalidEmptyStringDto: type: object properties: code: type: string enum: - INVALID_EMPTY_STRING path: type: string message: type: string received: {} required: - code - path - message id: ValidationInvalidEmptyStringDto ValidationUnknownFieldDto: type: object properties: code: type: string enum: - UNKNOWN_FIELD path: type: string message: type: string received: {} keys: type: array items: type: string required: - code - path - message - keys id: ValidationUnknownFieldDto ValidationTooSmallDto: type: object properties: code: type: string enum: - TOO_SMALL path: type: string message: type: string received: {} minimum: type: number inclusive: type: boolean origin: type: string required: - code - path - message - minimum - inclusive - origin id: ValidationTooSmallDto ValidationTooBigDto: type: object properties: code: type: string enum: - TOO_BIG path: type: string message: type: string received: {} maximum: type: number inclusive: type: boolean origin: type: string required: - code - path - message - maximum - inclusive - origin id: ValidationTooBigDto ValidationInvalidTypeDto: type: object properties: code: type: string enum: - INVALID_TYPE path: type: string message: type: string received: {} expected: type: string required: - code - path - message - expected id: ValidationInvalidTypeDto ValidationInvalidValueDto: type: object properties: code: type: string enum: - INVALID_VALUE path: type: string message: type: string received: {} expected: {} required: - code - path - message id: ValidationInvalidValueDto ValidationInvalidEmailDto: type: object properties: code: type: string enum: - INVALID_EMAIL path: type: string message: type: string received: {} required: - code - path - message id: ValidationInvalidEmailDto ValidationInvalidUuidDto: type: object properties: code: type: string enum: - INVALID_UUID path: type: string message: type: string received: {} required: - code - path - message id: ValidationInvalidUuidDto ValidationInvalidUrlDto: type: object properties: code: type: string enum: - INVALID_URL path: type: string message: type: string received: {} required: - code - path - message id: ValidationInvalidUrlDto ValidationInvalidDatetimeDto: type: object properties: code: type: string enum: - INVALID_DATETIME path: type: string message: type: string received: {} required: - code - path - message id: ValidationInvalidDatetimeDto ValidationInvalidDateDto: type: object properties: code: type: string enum: - INVALID_DATE path: type: string message: type: string received: {} required: - code - path - message id: ValidationInvalidDateDto ValidationInvalidTimeDto: type: object properties: code: type: string enum: - INVALID_TIME path: type: string message: type: string received: {} required: - code - path - message id: ValidationInvalidTimeDto ValidationInvalidDurationDto: type: object properties: code: type: string enum: - INVALID_DURATION path: type: string message: type: string received: {} required: - code - path - message id: ValidationInvalidDurationDto ValidationInvalidIpv4Dto: type: object properties: code: type: string enum: - INVALID_IPV4 path: type: string message: type: string received: {} required: - code - path - message id: ValidationInvalidIpv4Dto ValidationInvalidIpv6Dto: type: object properties: code: type: string enum: - INVALID_IPV6 path: type: string message: type: string received: {} required: - code - path - message id: ValidationInvalidIpv6Dto ValidationInvalidJsonStringDto: type: object properties: code: type: string enum: - INVALID_JSON_STRING path: type: string message: type: string received: {} required: - code - path - message id: ValidationInvalidJsonStringDto ValidationInvalidJwtDto: type: object properties: code: type: string enum: - INVALID_JWT path: type: string message: type: string received: {} required: - code - path - message id: ValidationInvalidJwtDto ValidationInvalidRegexDto: type: object properties: code: type: string enum: - INVALID_REGEX path: type: string message: type: string received: {} required: - code - path - message id: ValidationInvalidRegexDto ValidationInvalidPhoneNumberDto: type: object properties: code: type: string enum: - INVALID_PHONE_NUMBER path: type: string message: type: string received: {} required: - code - path - message id: ValidationInvalidPhoneNumberDto ValidationInvalidDomainDto: type: object properties: code: type: string enum: - INVALID_DOMAIN path: type: string message: type: string received: {} required: - code - path - message id: ValidationInvalidDomainDto ValidationInvalidHttpsUrlDto: type: object properties: code: type: string enum: - INVALID_HTTPS_URL path: type: string message: type: string received: {} required: - code - path - message id: ValidationInvalidHttpsUrlDto ValidationInvalidTimezoneDto: type: object properties: code: type: string enum: - INVALID_TIMEZONE path: type: string message: type: string received: {} required: - code - path - message id: ValidationInvalidTimezoneDto ValidationPaginationOffsetExceededDto: type: object properties: code: type: string enum: - PAGINATION_OFFSET_EXCEEDED path: type: string message: type: string received: {} maximum: type: number required: - code - path - message - maximum id: ValidationPaginationOffsetExceededDto LocationType: type: string enum: - primary_home - secondary_home - primary_work - headquarters - regional_office id: LocationType CustomTextTypeDto: type: object properties: viewType: type: string enum: - customText text: anyOf: - type: string - type: 'null' required: - viewType - text id: PrivateCustomTextTypeDto CustomNumberTypeDto: type: object properties: viewType: type: string enum: - customNumber number: anyOf: - type: number - type: 'null' required: - viewType - number id: PrivateCustomNumberTypeDto CustomCheckboxTypeDto: type: object properties: viewType: type: string enum: - customCheckbox checked: anyOf: - type: boolean - type: 'null' required: - viewType - checked id: PrivateCustomCheckboxTypeDto CustomDateTypeDto: type: object properties: viewType: type: string enum: - customDate date: anyOf: - $ref: '#/components/schemas/DateISO' - type: 'null' required: - viewType - date id: PrivateCustomDateTypeDto CustomTimestampTypeDto: type: object properties: viewType: type: string enum: - customTimestamp timestamp: anyOf: - $ref: '#/components/schemas/DateISO' - type: 'null' required: - viewType - timestamp id: PrivateCustomTimestampTypeDto CustomRatingTypeDto: type: object properties: viewType: type: string enum: - customRating rating: anyOf: - type: number - type: 'null' required: - viewType - rating id: PrivateCustomRatingTypeDto CustomSelectTypeDto: type: object properties: viewType: type: string enum: - customSelect select: anyOf: - type: string - type: 'null' required: - viewType - select id: PrivateCustomSelectTypeDto CustomMultiSelectTypeDto: type: object properties: viewType: type: string enum: - customMultiSelect multiSelect: type: array items: type: string required: - viewType - multiSelect id: PrivateCustomMultiSelectTypeDto CustomCurrencyTypeDto: type: object properties: viewType: type: string enum: - customCurrency monetaryAmount: anyOf: - $ref: '#/components/schemas/MonetaryAmountDto' - type: 'null' required: - viewType - monetaryAmount id: PrivateCustomCurrencyTypeDto CustomDateRangeTypeDto: type: object properties: viewType: type: string enum: - customDateRange dateRange: anyOf: - $ref: '#/components/schemas/DateRangeDto' - type: 'null' required: - viewType - dateRange id: PrivateCustomDateRangeTypeDto CustomDurationTypeDto: type: object properties: viewType: type: string enum: - customDuration duration: anyOf: - type: number - type: 'null' required: - viewType - duration id: PrivateCustomDurationTypeDto CustomUrlTypeDto: type: object properties: viewType: type: string enum: - customUrl url: anyOf: - type: string - type: 'null' required: - viewType - url id: PrivateCustomUrlTypeDto CustomEntityTypeDto: type: object properties: viewType: type: string enum: - customEntity type: type: string enum: - user id: anyOf: - type: string - type: 'null' entity: anyOf: - $ref: '#/components/schemas/UserBadgeDto' - type: 'null' required: - viewType - type - id id: PrivateCustomEntityTypeDto CustomMultiEntityTypeDto: type: object properties: viewType: type: string enum: - customMultiEntity type: type: string enum: - user ids: type: array items: type: string entities: type: array items: $ref: '#/components/schemas/UserBadgeDto' required: - viewType - type - ids id: PrivateCustomMultiEntityTypeDto MonetaryAmountDto: type: object properties: currency: $ref: '#/components/schemas/DmCurrency' amount: type: number required: - currency - amount id: PrivateMonetaryAmountDto DateRangeDto: type: object properties: startDate: $ref: '#/components/schemas/DateISO' endDate: anyOf: - $ref: '#/components/schemas/DateISO' - type: 'null' required: - startDate - endDate id: PrivateDateRangeDto DmCurrency: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTC - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLF - CLP - CNH - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - IMP - INR - IQD - IRR - ISK - JEP - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLE - SLL - SOS - SRD - SSP - STD - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VEF - VES - VND - VUV - WST - XAF - XAG - XAU - XCD - XCG - XDR - XOF - XPD - XPF - XPT - YER - ZAR - ZMW - ZWG - ZWL id: DmCurrency securitySchemes: x-api-key: type: apiKey name: x-api-key in: header description: >- API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard. ````