---
updatedAt: 2026-04-21T05:36:32.000Z
agentTools:
  projectIndex: https://developer.officernd.com/llms.txt
---

# Get opportunity

Get opportunity by id 

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

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "paths": {
    "/api/v2/organizations/{orgSlug}/opportunities/{opportunityId}": {
      "get": {
        "description": "Get opportunity by id \n\n Required scopes: `flex.community.opportunities.read`",
        "operationId": "OpportunitiesController_getItem_api/v2",
        "parameters": [
          {
            "name": "opportunityId",
            "required": true,
            "in": "path",
            "description": "opportunity id",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "orgSlug",
            "required": true,
            "in": "path",
            "description": "organization slug",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OpportunityResultDto"
                }
              }
            }
          }
        },
        "security": [
          {
            "oauth2": [
              "flex.community.opportunities.read"
            ]
          }
        ],
        "summary": "Get opportunity",
        "tags": [
          "Opportunities"
        ]
      }
    }
  },
  "info": {
    "title": "Community API",
    "description": "",
    "version": "2.0",
    "contact": {}
  },
  "servers": [
    {
      "url": "https://app.officernd.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "oauth2": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://identity.officernd.com/auth/token",
            "scopes": {}
          },
          "authorizationCode": {
            "authorizationUrl": "https://identity.officernd.com/auth/authorize",
            "tokenUrl": "https://identity.officernd.com/auth/token",
            "scopes": {}
          }
        }
      }
    },
    "schemas": {
      "OpportunityResultDto": {
        "type": "object",
        "properties": {
          "properties": {
            "type": "object",
            "description": "An object that contains all custom properties that can be applied to the item.",
            "example": {
              "customProperty1": "value1",
              "customProperty2": "value2"
            }
          },
          "_id": {
            "type": "string",
            "description": "The _id of the opportunity.",
            "example": "6acde3f72d2ed42e8be32b15"
          },
          "name": {
            "type": "string",
            "description": "The full name of the opportunity.",
            "example": "John Doe"
          },
          "company": {
            "type": "string",
            "description": "The _id of the contact company associated with the opportunity. Either a member or a company is necessary to create an opportunity.",
            "example": "6acde3f72d2ed42e8be32b16"
          },
          "member": {
            "type": "string",
            "description": "The _id of the contact member associated with the opportunity. Either a member or a company is necessary to create an opportunity.",
            "example": "6acde3f72d2ed42e8be32b17"
          },
          "status": {
            "type": "string",
            "description": "The _id of the status associated with the opportunity.",
            "example": "6acde3f72d2ed42e8be32b18"
          },
          "probability": {
            "type": "number",
            "description": "The probability of the deal, it should match the percentage associated with the status of the opportunity.",
            "example": 10
          },
          "startDate": {
            "format": "date-time",
            "type": "string",
            "description": "The start date of the opportunity.",
            "example": "2024-02-08T10:00:00.000Z"
          },
          "dealSize": {
            "type": "number",
            "description": "The size of the deal in currency.",
            "example": 500
          },
          "membersCount": {
            "type": "number",
            "description": "The number of members that come with the opportunity.",
            "example": 5
          },
          "resources": {
            "type": "string",
            "description": "Array containing all the _ids of resources associated with the opportunity.",
            "example": [
              "6acde3f72d2ed42e8be32b19",
              "6acde3f72d2ed42e8be32b1a"
            ]
          },
          "requestedPlans": {
            "type": "string",
            "description": "Array containing all the _ids of plans that were requested for the opportunity.",
            "example": [
              "6acde3f72d2ed42e8be32b1b",
              "6acde3f72d2ed42e8be32b1c"
            ]
          },
          "createdAt": {
            "type": "string",
            "description": "The date when the opportunity has been created.",
            "example": "2022-02-07T10:03:33.169Z"
          },
          "createdBy": {
            "type": "string",
            "description": "The id of the user that created the opportunity.",
            "example": "6acde3f72d2ed42e8be32b1d"
          },
          "modifiedAt": {
            "type": "string",
            "description": "The date of the last update of the opportunity.",
            "example": "2022-02-08T10:03:33.169Z"
          },
          "modifiedBy": {
            "type": "string",
            "description": "The id of user that did the last updated the opportunity.",
            "example": "6acde3f72d2ed42e8be32b1e"
          }
        }
      }
    }
  }
}
```