# Search Opportunities - **URL:** https://marketplace.gohighlevel.com/docs/ghl/opportunities/search-opportunities-advanced - **Summary:** Search Opportunities based on combinations of advanced filters. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-424216/7bf11bc9b94f80f [Skip to main content](https://marketplace.gohighlevel.com/docs/ghl/opportunities/search-opportunities-advanced#__docusaurus_skipToContent_fallback) Version: v3 Search Opportunities ==================== POST https://services.leadconnectorhq.com/opportunities/search Copy for LLMView as MarkdownOpen in ClaudeOpen in ChatGPTOpen in Cursor Search Opportunities based on combinations of advanced filters. Documentation Link - [https://doc.clickup.com/8631005/d/h/87cpx-424216/7bf11bc9b94f80f](https://doc.clickup.com/8631005/d/h/87cpx-424216/7bf11bc9b94f80f) ### Requirements #### Scope(s) `opportunities.readonly` #### Auth Method(s) `OAuth Access Token``Private Integration Token` #### Token Type(s) `Sub-Account Token` Request[​](https://marketplace.gohighlevel.com/docs/ghl/opportunities/search-opportunities-advanced#request "Direct link to request") ### Header Parameters **Version** stringrequired **Possible values:** \[`v3`\] API Version **Example:** `v3` * application/json * Body * Example (auto) ### Body**required** **locationId**stringrequired Location Id **Example:** `i2SpAtBVHSVea1sL6oah` **query**stringrequired Full-text search query string (max 75 characters) **Example:** `john@deo.com` **limit**numberrequired Maximum number of results to return per page **Example:** `20` **page**numberrequired Page number (0-indexed) **Example:** `0` **searchAfter**string\[\]required Search-after cursor values for deep pagination **Example:** `[1625203104328,"yWQobCRIhRguQtD2llvk"]` **additionalDetails** objectrequired Flags to include additional related entities in the response **notes**booleanrequired Include notes in the response **Example:** `false` **tasks**booleanrequired Include tasks in the response **Example:** `false` **calendarEvents**booleanrequired Include calendar events in the response **Example:** `false` **unReadConversations**booleanrequired Include unread conversations count in the response **Example:** `false` { "locationId": "i2SpAtBVHSVea1sL6oah", "query": "john@deo.com", "limit": 20, "page": 0, "searchAfter": [ 1625203104328, "yWQobCRIhRguQtD2llvk" ], "additionalDetails": { "notes": false, "tasks": false, "calendarEvents": false }} Responses[​](https://marketplace.gohighlevel.com/docs/ghl/opportunities/search-opportunities-advanced#responses "Direct link to Responses") * 200 * 400 * 401 * 422 Successful response * application/json * Schema * Example (auto) **Schema** **opportunities** object\[\] List of opportunities matching the search criteria * Array \[\ \ \ **id**string\ \ Unique identifier of the opportunity\ \ **Example:** `yWQobCRIhRguQtD2llvk`\ \ **name**string\ \ Name of the opportunity\ \ **Example:** `testing`\ \ **monetaryValue**number\ \ Monetary value of the opportunity\ \ **Example:** `500`\ \ **pipelineId**string\ \ Identifier of the pipeline the opportunity belongs to\ \ **Example:** `VDm7RPYC2GLUvdpKmBfC`\ \ **pipelineStageId**string\ \ Identifier of the pipeline stage the opportunity is in\ \ **Example:** `e93ba61a-53b3-45e7-985a-c7732dbcdb69`\ \ **assignedTo**string\ \ Identifier of the user the opportunity is assigned to\ \ **Example:** `zT46WSCPbudrq4zhWMk6`\ \ **status**string\ \ Current status of the opportunity\ \ **Example:** `open`\ \ **source**string\ \ Source of the opportunity\ \ **Example:**\ \ **lastStatusChangeAt**string\ \ ISO 8601 timestamp of the last status change\ \ **Example:** `2021-08-03T04:55:17.355Z`\ \ **lastStageChangeAt**string\ \ ISO 8601 timestamp of the last stage change\ \ **Example:** `2021-08-03T04:55:17.355Z`\ \ **lastActionDate**string\ \ ISO 8601 timestamp of the last action on the opportunity\ \ **Example:** `2021-08-03T04:55:17.355Z`\ \ **indexVersion**string\ \ Index version of the opportunity record\ \ **Example:** `1`\ \ **createdAt**string\ \ ISO 8601 timestamp when the opportunity was created\ \ **Example:** `2021-08-03T04:55:17.355Z`\ \ **updatedAt**string\ \ ISO 8601 timestamp when the opportunity was last updated\ \ **Example:** `2021-08-03T04:55:17.355Z`\ \ **forecastExpectedCloseDate**string\ \ Expected close date for the forecast (YYYY-MM-DD)\ \ **Example:** `2026-05-20`\ \ **forecastOriginalCloseDate**string\ \ Original forecast close date before any slippage (YYYY-MM-DD)\ \ **Example:** `2026-05-01`\ \ **forecastSlippageCount**number\ \ Number of times the close date has slipped\ \ **Example:** `2`\ \ **forecastDaysSlipped**number\ \ Total days the close date has slipped\ \ **Example:** `19`\ \ **forecastLastSlippedAt**string\ \ ISO 8601 timestamp of the last close-date slip\ \ **Example:** `2026-05-22T10:30:00.000Z`\ \ **forecastProbability**number\ \ Forecast win probability percentage (0–100)\ \ **Example:** `20`\ \ **effectiveProbability**number\ \ Effective win probability after stage and forecast adjustments (0–100)\ \ **Example:** `40`\ \ **contactId**string\ \ Identifier of the contact linked to the opportunity\ \ **Example:** `zT46WSCPbudrq4zhWMk6`\ \ **locationId**string\ \ Identifier of the location (sub-account) the opportunity belongs to\ \ **Example:** `zT46WSCPbudrq4zhW`\ \ **contact** object\ \ Contact details associated with the opportunity\ \ **id**string\ \ Unique identifier of the contact\ \ **Example:** `byMEV0NQinDhq8ZfiOi2`\ \ **name**string\ \ Full name of the contact\ \ **Example:** `John Deo`\ \ **companyName**string\ \ Company name associated with the contact\ \ **Example:** `Tesla Inc`\ \ **email**string\ \ Email address of the contact\ \ **Example:** `john@deo.com`\ \ **phone**string\ \ Phone number of the contact\ \ **Example:** `+1202-555-0107`\ \ **tags**string\[\]\ \ Tags associated with the contact\ \ **Example:** `["lead","vip"]`\ \ **notes**array\[\]\ \ Notes attached to the opportunity\ \ **Example:** `[]`\ \ **tasks**array\[\]\ \ Tasks attached to the opportunity\ \ **Example:** `[]`\ \ **calendarEvents**array\[\]\ \ Calendar events attached to the opportunity\ \ **Example:** `[]`\ \ **lostReasonId**string\ \ Identifier of the lost reason if the opportunity was marked lost\ \ **Example:** `zT46WSCPbudrq4zhWMk6`\ \ **customFields** object\[\]\ \ Custom fields associated with the opportunity\ \ * Array \[\ \ \ **id**stringrequired\ \ Unique identifier of the custom field\ \ **Example:** `MgobCB14YMVKuE4Ka8p1`\ \ **fieldValue** objectrequired\ \ The value of the custom field\ \ oneOf\ \ * string\ * object\ * string\[\]\ * object\[\]\ \ string\ \ * \]\ \ \ **followers**array\[\]\ \ User IDs following this opportunity\ \ **Example:** `["sx6wyHhbFdRXh302Lunr"]`\ \ **externalObjectId**string\ \ External object identifier for integrations\ \ **Example:** `ext_obj_12345`\ \ * \] **total**numberrequired Total number of opportunities matching the query **Example:** `100` **stageAggregations** object\[\] Per-stage totals when pipeline filter is present * Array \[\ \ \ **pipelineStageId**stringrequired\ \ Identifier of the pipeline stage being aggregated\ \ **Example:** `e93ba61a-53b3-45e7-985a-c7732dbcdb69`\ \ **totalCount**numberrequired\ \ Total number of opportunities in this stage\ \ **Example:** `12`\ \ **totalValue**numberrequired\ \ Total monetary value of all opportunities in this stage\ \ **Example:** `24500`\ \ **weightedValue**numberrequired\ \ Probability-weighted total value of opportunities in this stage\ \ **Example:** `14700`\ \ **openValue**numberrequired\ \ Total value of open opportunities in this stage\ \ **Example:** `18000`\ \ **openWeightedValue**numberrequired\ \ Probability-weighted value of open opportunities in this stage\ \ **Example:** `10800`\ \ **wonValue**numberrequired\ \ Total value of won opportunities in this stage\ \ **Example:** `6500`\ \ * \] **aggregations**object Aggregation results keyed by aggregation name **Example:** `{}` { "opportunities": [], "total": 100, "stageAggregations": [], "aggregations": {}} > Common reference appendix (shared error/status catalog): see [../_shared-appendix.md](../_shared-appendix.md). **name:** [Authorization](https://marketplace.gohighlevel.com/docs/ghl/opportunities/opportunities-api-v-3#authentication) **type:** http**scopes:** `opportunities.readonly`**scheme:** bearer**bearerFormat:** JWT**in:** header**description:** Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account. * curl * nodejs * python * php * java * go * ruby * powershell * CURL curl -L 'https://services.leadconnectorhq.com/opportunities/search' \-H 'Content-Type: application/json' \-H 'Accept: application/json' \-H 'Version: v3' \-H 'Authorization: Bearer ' \--data-raw '{ "locationId": "i2SpAtBVHSVea1sL6oah", "query": "john@deo.com", "limit": 20, "page": 0, "searchAfter": [ 1625203104328, "yWQobCRIhRguQtD2llvk" ], "additionalDetails": { "notes": false, "tasks": false, "calendarEvents": false, "unReadConversations": false }}' RequestCollapse all Base URL Edit https://services.leadconnectorhq.com Auth Bearer Token Parameters Version — headerrequired\---v3 Body required { "locationId": "i2SpAtBVHSVea1sL6oah", "query": "john@deo.com", "limit": 20, "page": 0, "searchAfter": \[ 1625203104328, "yWQobCRIhRguQtD2llvk" \], "additionalDetails": { "notes": false, "tasks": false, "calendarEvents": false, "unReadConversations": false } } Send API Request ResponseClear Click the `Send API Request` button above and see the response here!