*REST API › Endpoint reference › CRM*

# Get an opportunity

> Returns the record of an opportunity: the summary plus the description, the collaborators and the linked quotes.

With `includeHistory=true` it adds `stageHistory`, the stage moves from most recent to oldest — it is an additional query, so it does not come by default.

`GET /api/v1/crm/opportunities/{opportunityId}` — scope `crm:read`

Scope: `crm:read` · 120/min · Strict tenancy · Add-on (402) · If-None-Match · MCP: `filmo_crm_opportunities_get`

## Authorizations

Bearer API key with the scope below. `crm:read`

## Headers

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `If-None-Match` | string | No | Conditional read: the `ETag` of the copy you already have. If the resource has not changed, the response is `304` with no body. |

## Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `opportunityId` | string | Yes | Opportunity identifier. |

## Request examples

*Get an opportunity*

**cURL**

```bash
curl https://app.filmo.io/api/v1/crm/opportunities/oppo_8f2a1c \
  --header "Authorization: Bearer $FILMO_API_KEY"
```

**Node.js**

```javascript
fetch('https://app.filmo.io/api/v1/crm/opportunities/oppo_8f2a1c', {
  headers: {
    Authorization: 'Bearer YOUR_FILMO_API_KEY'
  }
})
```

**Python**

```python
import requests

requests.get(
    "https://app.filmo.io/api/v1/crm/opportunities/oppo_8f2a1c",
    headers={
      "Authorization": "Bearer YOUR_FILMO_API_KEY"
    }
)
```

## Response

Response schema: `OpportunityDetailDto`

| Status | Description |
| --- | --- |
| 200 | Successful response. |
| 304 | Not modified: the `If-None-Match` sent matches the current `ETag`. No body; the copy you have is current. |
| 401 | Authentication failed (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin). |
| 402 | Add-on required (addon_required): the account plan does not include the add-on this operation needs; `requiredAddon` names it. |
| 403 | Not allowed (insufficient_scope: the API key does not have the required scope, named in `requiredScope`; forbidden: the owner of the key lacks the permission the operation requires). `insufficient_scope` is answered before the request counts against the rate limit, so it carries no `RateLimit-*` headers; `forbidden` does. |
| 404 | Resource not found (not_found): it does not exist or is outside the scope of the API key. |
| 429 | Rate limit exceeded (rate_limited): retry after `Retry-After` seconds; `RateLimit-*` says which quota ran out. |
| 500 | Internal error (internal_error). |

**200**

| Name | Type | Description |
| --- | --- | --- |
| `data` | object | Full detail of a CRM opportunity. |
| `data.opportunityId` | string |  |
| `data.identifier` | string |  |
| `data.name` | string |  |
| `data.status` | string |  `open`, `won`, `lost` |
| `data.amount` | string |  |
| `data.currency` | string |  |
| `data.pipelineId` | string |  |
| `data.pipelineName` | string |  |
| `data.stageId` | string |  |
| `data.stageName` | string |  |
| `data.stageType` | string |  `open`, `won`, `lost` |
| `data.effectiveProbability` | number |  |
| `data.weightedAmount` | string |  |
| `data.daysInStage` | integer |  |
| `data.expectedCloseDate` | string<date-time> |  |
| `data.contactName` | string |  |
| `data.companyName` | string |  |
| `data.ownerName` | string |  |
| `data.source` | string |  `inbound_email`, `website_form`, `referral`, `cold_outreach`, `event`, `social`, `existing_customer`, `partner`, `other` |
| `data.createdAt` | string<date-time> |  |
| `data.updatedAt` | string<date-time> |  |
| `data.description` | string |  |
| `data.version` | integer |  |
| `data.collaboratorStaffIds` | string[] |  |
| `data.quoteIds` | string[] |  |
| `data.stageHistory` | object[] |  |
| `data.stageHistory.fromStageId` | string |  |
| `data.stageHistory.toStageId` | string |  |
| `data.stageHistory.toStatus` | string |  |
| `data.stageHistory.daysInPrevStage` | integer |  |
| `data.stageHistory.movedAt` | string<date-time> |  |
| `data.stageHistory.note` | string |  |
| `meta` | object | Additional information about the response. |
| `meta.warnings` | object[] | Lifecycle warnings; present only when the operation is deprecated. |
| `meta.warnings.code` | string | Stable warning code. `deprecated` |
| `meta.warnings.message` | string | For people: what is deprecated, until when, and what to use. |
| `meta.warnings.sunset` | string | Day (YYYY-MM-DD) the operation stops being served. |
| `meta.warnings.replacement` | string | `operationId` of the operation to use instead, or null if there is none. |
| `meta.warnings.link` | string | Where the deprecation is documented (the changelog). |

*Example response · 200*

```json
{
  "data": {
    "opportunityId": "opportunity_9f3a2b",
    "identifier": "Example identifier",
    "name": "Example opportunity",
    "status": "open",
    "amount": "120.00",
    "currency": "EUR",
    "pipelineId": "pipeline_9f3a2b",
    "pipelineName": "Example pipeline name",
    "stageId": "stage_9f3a2b",
    "stageName": "Example stage name",
    "stageType": "open",
    "effectiveProbability": 1,
    "weightedAmount": "120.00",
    "daysInStage": 1,
    "expectedCloseDate": "2026-09-01T10:00:00+02:00",
    "contactName": "Example contact name",
    "companyName": "Example company name",
    "ownerName": "Example owner name",
    "source": "inbound_email",
    "createdAt": "2026-09-01T10:00:00+02:00",
    "updatedAt": "2026-09-01T10:00:00+02:00",
    "description": "Example text.",
    "version": 1,
    "collaboratorStaffIds": [
      "collaborator_staff_9f3a2b"
    ],
    "quoteIds": [
      "quote_9f3a2b"
    ],
    "stageHistory": [
      {
        "fromStageId": "from_stage_9f3a2b",
        "toStageId": "to_stage_9f3a2b",
        "toStatus": "Example to status",
        "daysInPrevStage": 1,
        "movedAt": "2026-09-01T10:00:00+02:00",
        "note": "Example text."
      }
    ]
  }
}
```

304: No body.

## Errors

| Status | Codes | Meaning |
| --- | --- | --- |
| 402 | `addon_required` | The account plan does not include the add-on this operation needs; `requiredAddon` names it. |
| 404 | `not_found` | It does not exist or is outside the scope of the API key. |

## Deprecation

This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date.

---

Canonical URL: https://docs.filmo.io/rest-api/endpoint-reference/crm/get-an-opportunity  
Last updated: 2026-10-25