---
title: "Get opportunities"
method: GET
path: "/api/v2/organizations/{orgSlug}/opportunities"
tags: ["Opportunities"]
---

# Get opportunities

`GET /api/v2/organizations/{orgSlug}/opportunities`

## Request

- Base URL: `https://app.officernd.com`
- URL: `https://app.officernd.com/api/v2/organizations/{orgSlug}/opportunities`
- Auth: OAuth 2
  - Authorization code: `https://identity.officernd.com/auth/authorize`
  - Client credentials
  - Token URL: `https://identity.officernd.com/auth/token` scopes: `flex.community.opportunities.read`

Retrieve a list of opportunities based on provided filters 

 Required scopes: `flex.community.opportunities.read`

## Path parameters

- `orgSlug` string, required

## Query parameters

- `_id` string
- `company` string
- `member` string
- `createdAt` string
- `modifiedAt` string
- `$select` string
- `$cursorNext` string
- `$cursorPrev` string
- `$limit` number

## Response `200`

- object
  - `rangeStart` number
  - `rangeEnd` number
  - `cursorNext` string
  - `cursorPrev` string
  - `results` OpportunityResultDto[]
    - `properties` object: An object that contains all custom properties that can be applied to the item.
    - `_id` string: The _id of the opportunity.
    - `name` string: The full name of the opportunity.
    - `company` string: The _id of the contact company associated with the opportunity. Either a member or a company is necessary to create an opportunity.
    - `member` string: The _id of the contact member associated with the opportunity. Either a member or a company is necessary to create an opportunity.
    - `status` string: The _id of the status associated with the opportunity.
    - `probability` number: The probability of the deal, it should match the percentage associated with the status of the opportunity.
    - `startDate` string, date-time: The start date of the opportunity.
    - `dealSize` number: The size of the deal in currency.
    - `membersCount` number: The number of members that come with the opportunity.
    - `resources` string: Array containing all the _ids of resources associated with the opportunity.
    - `requestedPlans` string: Array containing all the _ids of plans that were requested for the opportunity.
    - `createdAt` string: The date when the opportunity has been created.
    - `createdBy` string: The id of the user that created the opportunity.
    - `modifiedAt` string: The date of the last update of the opportunity.
    - `modifiedBy` string: The id of user that did the last updated the opportunity.

---

[API](https://skmtc.dev/officernd/apis/community-api.md) - [All operations](https://skmtc.dev/officernd/apis/community-api/llms.txt) - [OpenAPI document](https://skmtc.dev/officernd/apis/community-api/revisions/dad1b7912165?raw)