*REST API › Endpoint reference › CRM*

# List opportunities

> Returns the sales opportunities with their pipeline, their stage and their amount weighted by the probability of the stage.

By default only the open ones: pass `status=won`, `lost` or `all` for the rest. It paginates by a cursor specific to the CRM service.

`GET /api/v1/crm/opportunities` — scope `crm:read`

Scope: `crm:read` · 120/min · Strict tenancy · Add-on (402) · MCP: `filmo_crm_opportunities_list`

## Authorizations

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

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | integer | No | Page size (1-500). Defaults to 50. = `50` |
| `cursor` | string | No | Opaque cursor of the page to return. Pass the value of `pagination.nextCursor` from the previous response; treat it as opaque. |
| `sort` | string | No | Sort order: up to 3 comma-separated fields, each with a leading "-" for descending (e.g. "-updatedAt,name"). Sortable fields: createdAt, updatedAt, name, identifier, status, amount, expectedCloseDate. Defaults to "-createdAt". Ties are broken by id, so the order is stable across pages, and a cursor is bound to the sort it was issued with. |
| `pipelineId` | string | No | Returns only the opportunities in this pipeline. |
| `stageId` | string | No | Returns only the opportunities in this stage. |
| `status` | string | No | Commercial status: open (the default), won, lost or all. `open`, `won`, `lost`, `all` |
| `contactId` | string | No | Returns only the opportunities of this contact. |
| `q` | string | No | Free-text search on the name and the identifier. |
| `expectedCloseFrom` | string | No | Expected close date from this date (ISO 8601). |
| `expectedCloseTo` | string | No | Expected close date up to this date (ISO 8601). |
| `includeTotal` | boolean | No | Set it to true to include `pagination.total`, the number of results that match the filters across all pages. Off by default. = `false` |

## Request examples

*List opportunities*

**cURL**

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

**Node.js**

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

**Python**

```python
import requests

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

## Response

Response schema: `OpportunityDto`

| Status | Description |
| --- | --- |
| 200 | Successful response. |
| 400 | Invalid request (validation_error): malformed query or body. `errors[]` lists every offending field with its stable code. |
| 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. |
| 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[] |  |
| `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> |  |
| `pagination` | object | Opaque-cursor pagination metadata. |
| `pagination.nextCursor` | string | Opaque cursor of the next page; null when there are no more results. Pass it as `cursor` in the next request. |
| `pagination.hasMore` | boolean | Whether more results exist beyond this page. |
| `pagination.total` | integer | Number of results matching the filters across all pages. Present only when the request sets `includeTotal=true`. |
| `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"
    }
  ],
  "pagination": {
    "nextCursor": "eyJvIjoyMH0",
    "hasMore": true,
    "total": 1
  }
}
```

## Errors

| Status | Codes | Meaning |
| --- | --- | --- |
| 400 | `validation_error` | Malformed query or body. `errors[]` lists every offending field with its stable code. |
| 402 | `addon_required` | The account plan does not include the add-on this operation needs; `requiredAddon` names it. |

## 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/list-opportunities  
Last updated: 2026-10-25