# Retrieve an opportunity

Operation ID: `getOpportunity`

Group: CRM › Opportunities

[Open in the interactive reference](https://docs.api.lensing.ai/lensing/v1/endpoints/getOpportunity)

`GET /crm/opportunities/{id}`

Read-only: Reads and returns; changes nothing.

Retrieves an opportunity.

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `Api-Version` | header | string · v1 | yes | The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`. |
| `id` | path | string | yes | The unique identifier of the opportunity you want to retrieve. |

## Response

`200` Success

Under `data` (getOpportunityOutput):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | yes | The unique identifier for the opportunity. |
| `opportunityNumber` | string | no | The system-generated opportunity number, for example 'OP-1042'. Absent while none has been assigned. |
| `entityId` | string | yes | The legal entity that owns the opportunity. |
| `currency` | string | yes | The currency the opportunity is denominated in, and the currency of amount. Format ISO 4217, for example 'USD'. |
| `customerId` | string | no | The identifier of the customer or prospect this opportunity is for. customerPath says which kind of record it is. Absent when it points at neither. See id on GET accounting/customers/:id for a customer, or GET crm/prospects/:id for a prospect. |
| `customerPath` | string | no | Which kind of record customerId identifies. The value ends in 'Customer.id' when it is a customer and in 'Prospect.id' when it is a prospect. Absent when neither resolves. |
| `endCustomerId` | string | no | The identifier of the end customer behind a partner customer. Absent unless one is on record. See id on GET accounting/customers/:id. |
| `priceBookId` | string | yes | The identifier of the price book quotes on this opportunity are priced from. See id on GET accounting/price-books/:id. |
| `stageId` | string | yes | The identifier of the stage the opportunity currently sits in: one of the stages on GET crm/opportunity-stages/:id, where :id is this opportunity's entityId. |
| `opportunityName` | string | no | The free-text display name of the opportunity. Absent when none is set. |
| `closeDate` | date | no | The expected close date of the deal. Format YYYY-MM-DD. Absent when none is set. |
| `amount` | decimal | no | The expected deal amount, as a decimal in the opportunity's currency. Absent when none is set. |
| `crmId` | string | no | The identifier of this opportunity in the external system it was imported from, for example a Salesforce record id. It is free text and not unique. Absent when none is set. |
| `dataSource` | string | no | The system the record came from, for example 'Salesforce'. Records created in Lensing have the value 'Everest'. Absent when none is set. |
| `lastModifiedDate` | date-time | no | The date and time the opportunity record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. |
| `quotes` | array<object> | yes | Every quote linked to this opportunity. An empty array when it has none. |
| `quotes[].quoteId` | string | yes | The identifier of the linked quote. See id on GET crm/quotes/:id. |
| `quotes[].isPrimary` | boolean | yes | Whether this is a primary quote for the opportunity. It is not guaranteed to be true for exactly one quote. |

```json
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "opportunityNumber": "<opportunityNumber>",
    "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "currency": "<currency>",
    "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "customerPath": "<customerPath>",
    "endCustomerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "priceBookId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "stageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "opportunityName": "<opportunityName>",
    "closeDate": "2026-01-15",
    "amount": "19.99",
    "crmId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "dataSource": "<dataSource>",
    "lastModifiedDate": "2026-01-15T09:30:00.000Z",
    "quotes": [
      {
        "quoteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "isPrimary": true
      }
    ]
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}
```

## Errors

| Code | Status |
| --- | --- |
| `NOT_FOUND` | 400 |

## Statuses

- `400` — Invalid request or business failure. Codes: NOT_FOUND
- `401` — The request carries no valid access token.
- `403` — Not authorized
- `404` — Not found
- `429` — Too many requests from this client address. The response has no body and no `Retry-After` header.
- `500` — Internal server error