> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.itspropel.com/llms.txt. > For full documentation content, see https://docs.itspropel.com/llms-full.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.itspropel.com/_mcp/server. # List Opportunities GET https://leads/opportunities Cursor-paginated list of Opportunities visible to the current tenant + tenant_location. **Query params (all optional):** - `customer_id` (uuid), `customer_location_id` (uuid) - `opportunity_stage_id` (uuid), `assigned_user_id` (uuid) - `is_open` (bool): only non-terminal - `expected_close_from` / `expected_close_to` (date) - `origin` (enum case) - `original_lead_id` (uuid) - `service_category_id` (uuid) - `search` (string max 255), `cursor`, `per_page` (1-100) Reference: https://docs.itspropel.com/propel-biz/34-leads/opportunities/34-leads-opportunities-crud/list-opportunities ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: PropelBiz version: 1.0.0 paths: /leads/opportunities: get: operationId: list-opportunities summary: List Opportunities description: >- Cursor-paginated list of Opportunities visible to the current tenant + tenant_location. **Query params (all optional):** - `customer_id` (uuid), `customer_location_id` (uuid) - `opportunity_stage_id` (uuid), `assigned_user_id` (uuid) - `is_open` (bool): only non-terminal - `expected_close_from` / `expected_close_to` (date) - `origin` (enum case) - `original_lead_id` (uuid) - `service_category_id` (uuid) - `search` (string max 255), `cursor`, `per_page` (1-100) tags: - >- subpackage_34Leads.subpackage_34Leads/opportunities.subpackage_34Leads/opportunities/34LeadsOpportunitiesCrud parameters: - name: customer_id in: query description: 'Optional: Customer UUID' required: false schema: type: string - name: customer_location_id in: query description: 'Optional: Customer location UUID' required: false schema: type: string - name: opportunity_stage_id in: query description: 'Optional: Stage UUID' required: false schema: type: string - name: assigned_user_id in: query description: 'Optional: Assignee UUID' required: false schema: type: string - name: is_open in: query description: 'Optional: true|false' required: false schema: type: string - name: expected_close_from in: query description: 'Optional: Date (ISO-8601)' required: false schema: type: string - name: expected_close_to in: query description: 'Optional: Date (ISO-8601)' required: false schema: type: string - name: origin in: query description: 'Optional: OpportunityOrigin enum case' required: false schema: type: string - name: original_lead_id in: query description: 'Optional: Source lead UUID' required: false schema: type: string - name: service_category_id in: query description: 'Optional: Service category UUID' required: false schema: type: string - name: search in: query description: 'Optional: search term - max 255' required: false schema: type: string - name: per_page in: query description: 'Optional: Results per page (default 15, max 100)' required: false schema: type: integer - name: cursor in: query description: 'Optional: Cursor pagination token' required: false schema: type: string - name: '{{tenant_key_name}}' in: header required: false schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: >- #/components/schemas/34 Leads_Opportunities_34 Leads > Opportunities > CRUD_List Opportunities_Response_200 servers: - url: https:/ components: schemas: 34 Leads_Opportunities_34 Leads > Opportunities > CRUD_List Opportunities_Response_200: type: object properties: {} description: Empty response body title: >- 34 Leads_Opportunities_34 Leads > Opportunities > CRUD_List Opportunities_Response_200 ``` ## SDK Code Examples ```python import requests url = "https://https/leads/opportunities" querystring = {"customer_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","customer_location_id":"7c9e6679-7425-40de-944b-e07fc1f90ae7","opportunity_stage_id":"1b4e28ba-2fa1-11d2-883f-0016d3cca427","assigned_user_id":"f47ac10b-58cc-4372-a567-0e02b2c3d479","is_open":"true","expected_close_from":"2024-07-01","expected_close_to":"2024-07-31","origin":"referral","original_lead_id":"9b2d7f4e-3c4a-4f5a-8a2d-1e2f3b4c5d6e","service_category_id":"d94f3f01-2a1b-4c3d-9e7f-8a9b0c1d2e3f","search":"enterprise software upgrade","per_page":"25","cursor":"eyJwYWdlIjoxLCJpZCI6IjY1NDMyMSJ9"} payload = {} headers = { "{{tenant_key_name}}": "{{tenant_key_value1}}|{{tenant_key_value2}}", "Content-Type": "application/json" } response = requests.get(url, json=payload, headers=headers, params=querystring) print(response.json()) ``` ```javascript const url = 'https://https/leads/opportunities?customer_id=3fa85f64-5717-4562-b3fc-2c963f66afa6&customer_location_id=7c9e6679-7425-40de-944b-e07fc1f90ae7&opportunity_stage_id=1b4e28ba-2fa1-11d2-883f-0016d3cca427&assigned_user_id=f47ac10b-58cc-4372-a567-0e02b2c3d479&is_open=true&expected_close_from=2024-07-01&expected_close_to=2024-07-31&origin=referral&original_lead_id=9b2d7f4e-3c4a-4f5a-8a2d-1e2f3b4c5d6e&service_category_id=d94f3f01-2a1b-4c3d-9e7f-8a9b0c1d2e3f&search=enterprise+software+upgrade&per_page=25&cursor=eyJwYWdlIjoxLCJpZCI6IjY1NDMyMSJ9'; const options = { method: 'GET', headers: { '{{tenant_key_name}}': '{{tenant_key_value1}}|{{tenant_key_value2}}', 'Content-Type': 'application/json' }, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://https/leads/opportunities?customer_id=3fa85f64-5717-4562-b3fc-2c963f66afa6&customer_location_id=7c9e6679-7425-40de-944b-e07fc1f90ae7&opportunity_stage_id=1b4e28ba-2fa1-11d2-883f-0016d3cca427&assigned_user_id=f47ac10b-58cc-4372-a567-0e02b2c3d479&is_open=true&expected_close_from=2024-07-01&expected_close_to=2024-07-31&origin=referral&original_lead_id=9b2d7f4e-3c4a-4f5a-8a2d-1e2f3b4c5d6e&service_category_id=d94f3f01-2a1b-4c3d-9e7f-8a9b0c1d2e3f&search=enterprise+software+upgrade&per_page=25&cursor=eyJwYWdlIjoxLCJpZCI6IjY1NDMyMSJ9" payload := strings.NewReader("{}") req, _ := http.NewRequest("GET", url, payload) req.Header.Add("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://https/leads/opportunities?customer_id=3fa85f64-5717-4562-b3fc-2c963f66afa6&customer_location_id=7c9e6679-7425-40de-944b-e07fc1f90ae7&opportunity_stage_id=1b4e28ba-2fa1-11d2-883f-0016d3cca427&assigned_user_id=f47ac10b-58cc-4372-a567-0e02b2c3d479&is_open=true&expected_close_from=2024-07-01&expected_close_to=2024-07-31&origin=referral&original_lead_id=9b2d7f4e-3c4a-4f5a-8a2d-1e2f3b4c5d6e&service_category_id=d94f3f01-2a1b-4c3d-9e7f-8a9b0c1d2e3f&search=enterprise+software+upgrade&per_page=25&cursor=eyJwYWdlIjoxLCJpZCI6IjY1NDMyMSJ9") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["{{tenant_key_name}}"] = '{{tenant_key_value1}}|{{tenant_key_value2}}' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://https/leads/opportunities?customer_id=3fa85f64-5717-4562-b3fc-2c963f66afa6&customer_location_id=7c9e6679-7425-40de-944b-e07fc1f90ae7&opportunity_stage_id=1b4e28ba-2fa1-11d2-883f-0016d3cca427&assigned_user_id=f47ac10b-58cc-4372-a567-0e02b2c3d479&is_open=true&expected_close_from=2024-07-01&expected_close_to=2024-07-31&origin=referral&original_lead_id=9b2d7f4e-3c4a-4f5a-8a2d-1e2f3b4c5d6e&service_category_id=d94f3f01-2a1b-4c3d-9e7f-8a9b0c1d2e3f&search=enterprise+software+upgrade&per_page=25&cursor=eyJwYWdlIjoxLCJpZCI6IjY1NDMyMSJ9") .header("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('GET', 'https://https/leads/opportunities?customer_id=3fa85f64-5717-4562-b3fc-2c963f66afa6&customer_location_id=7c9e6679-7425-40de-944b-e07fc1f90ae7&opportunity_stage_id=1b4e28ba-2fa1-11d2-883f-0016d3cca427&assigned_user_id=f47ac10b-58cc-4372-a567-0e02b2c3d479&is_open=true&expected_close_from=2024-07-01&expected_close_to=2024-07-31&origin=referral&original_lead_id=9b2d7f4e-3c4a-4f5a-8a2d-1e2f3b4c5d6e&service_category_id=d94f3f01-2a1b-4c3d-9e7f-8a9b0c1d2e3f&search=enterprise+software+upgrade&per_page=25&cursor=eyJwYWdlIjoxLCJpZCI6IjY1NDMyMSJ9', [ 'body' => '{}', 'headers' => [ 'Content-Type' => 'application/json', '{{tenant_key_name}}' => '{{tenant_key_value1}}|{{tenant_key_value2}}', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://https/leads/opportunities?customer_id=3fa85f64-5717-4562-b3fc-2c963f66afa6&customer_location_id=7c9e6679-7425-40de-944b-e07fc1f90ae7&opportunity_stage_id=1b4e28ba-2fa1-11d2-883f-0016d3cca427&assigned_user_id=f47ac10b-58cc-4372-a567-0e02b2c3d479&is_open=true&expected_close_from=2024-07-01&expected_close_to=2024-07-31&origin=referral&original_lead_id=9b2d7f4e-3c4a-4f5a-8a2d-1e2f3b4c5d6e&service_category_id=d94f3f01-2a1b-4c3d-9e7f-8a9b0c1d2e3f&search=enterprise+software+upgrade&per_page=25&cursor=eyJwYWdlIjoxLCJpZCI6IjY1NDMyMSJ9"); var request = new RestRequest(Method.GET); request.AddHeader("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}"); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "{{tenant_key_name}}": "{{tenant_key_value1}}|{{tenant_key_value2}}", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://https/leads/opportunities?customer_id=3fa85f64-5717-4562-b3fc-2c963f66afa6&customer_location_id=7c9e6679-7425-40de-944b-e07fc1f90ae7&opportunity_stage_id=1b4e28ba-2fa1-11d2-883f-0016d3cca427&assigned_user_id=f47ac10b-58cc-4372-a567-0e02b2c3d479&is_open=true&expected_close_from=2024-07-01&expected_close_to=2024-07-31&origin=referral&original_lead_id=9b2d7f4e-3c4a-4f5a-8a2d-1e2f3b4c5d6e&service_category_id=d94f3f01-2a1b-4c3d-9e7f-8a9b0c1d2e3f&search=enterprise+software+upgrade&per_page=25&cursor=eyJwYWdlIjoxLCJpZCI6IjY1NDMyMSJ9")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```