> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.coperniq.io/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.coperniq.io/_mcp/server. # Search Opportunities GET https://api.coperniq.io/v1/opportunities/search Search opportunities using up to two filters (prop1/op1/value1 and optionally prop2/op2/value2), combined with `logic` (AND/OR). Properties: - `propX` can be a standard field (e.g., `status`, `title`, `city`, `type`, `accountId`, etc.) or a custom property key name. - Use the `property key` from your company settings. - Filter by parent account with `accountId`. `clientId` is accepted as a deprecated alias for backwards compatibility. Operators (`opX`): - Equality: `eq`, `neq` - Numeric/datetime comparisons: `gt`, `gte`, `lt`, `lte` - Text/string matching: `contains` (case-insensitive) - Lists: `in`, `nin` (CSV list in `valueX`) - Ranges: `between` (use `valueX` as `from,to`) - Existence: `exists` is not supported for custom properties due to performance limitations. Use `eq` or `neq` instead. - `status` has a fixed set of values, so it supports only `eq`, `neq`, `in`, and `nin`. Value formats: - `in`/`nin`: lists can be provided as: - Plain CSV: `value1=OPEN,ACTIVE` - Quoted CSV (to include commas inside a value): `value1="Last, First",Other` - JSON array: `value1=["Last, First","Other"]` - `between`: `from,to` (e.g., `value1=2025-01-01,2025-12-31` or `value1=10,20`) - Dates should be ISO 8601 strings; numeric-like values on custom properties are matched against both numeric and text representations. Examples: - status equals ACTIVE: `?prop1=status&op1=eq&value1=ACTIVE` - won or lost: `?prop1=status&op1=in&value1=WON,LOST` (opportunity status is `ACTIVE`, `ON_HOLD`, `WON`, or `LOST`) - custom id equals 1234: `?prop1=legacy_tool_project_id&op1=eq&value1=1234` - title contains "Solar": `?prop1=name&op1=contains&value1=Solar` - status IN (ACTIVE, ON_HOLD) AND city = Austin: `?prop1=status&op1=in&value1=ACTIVE,ON_HOLD&logic=and&prop2=city&op2=eq&value2=Austin` **Note:** The `/requests` path is an alias for `/opportunities` and will continue to work until users are individually notified and migrated. **Note:** If an opportunity has no `title` (empty or whitespace-only), the response returns the parent account's `title` instead. The stored value is not modified — this is a read-time fallback only. Reference: https://docs.coperniq.io/api-reference/opportunities/search-opportunities ## Authentication - `x-api-key` header (required) — API Key authentication via header ## Request ### Query parameters - `prop1` (string, required) — First field to filter (standard or custom keyName) - `op1` (enum, required) — Operator for prop1 - Allowed values: `eq`, `neq`, `gt`, `gte`, `lt`, `lte`, `contains`, `in`, `nin`, `between` - `value1` (string, required) — Value for prop1 (comma-separated values for in/nin or between) - `logic` (enum, optional, default: and) — Logical combination when both prop1 and prop2 are provided - Allowed values: `and`, `or` - `prop2` (string, optional) — Optional second field to filter - `op2` (enum, optional) — Operator for prop2 - Allowed values: `eq`, `neq`, `gt`, `gte`, `lt`, `lte`, `contains`, `in`, `nin`, `between` - `value2` (string, optional) — Value for prop2 (comma-separated values for in/nin or between) - `page_size` (integer, optional, default: 20) — Number of items per page (max 100) - `page` (integer, optional, default: 1) — Page number (1-based) - `entered_phase_id` (integer, optional) — Phase template ID to filter by phase-entry date. Required when `entered_after` or `entered_before` is provided. Given alone (no date bounds), matches records that ever entered this phase. - `entered_after` (string, optional) — Only include records that entered the phase given by `entered_phase_id` on or after this date/timestamp. Accepts a date (`2026-07-01`) or a full ISO 8601 timestamp (`2026-07-01T00:00:00Z`). Requires `entered_phase_id`. - `entered_before` (string, optional) — Only include records that entered the phase given by `entered_phase_id` before this date/timestamp (exclusive). Accepts a date (`2026-08-01`) or a full ISO 8601 timestamp (`2026-08-01T00:00:00Z`). Requires `entered_phase_id`. - `exited_phase_id` (integer, optional) — Phase template ID to filter by phase-exit date. Required when `exited_after` or `exited_before` is provided. Given alone (no date bounds), matches records that have exited this phase at any point. - `exited_after` (string, optional) — Only include records that exited the phase given by `exited_phase_id` on or after this date/timestamp. Accepts a date (`2026-07-01`) or a full ISO 8601 timestamp (`2026-07-01T00:00:00Z`). Requires `exited_phase_id`. - `exited_before` (string, optional) — Only include records that exited the phase given by `exited_phase_id` before this date/timestamp (exclusive). Accepts a date (`2026-08-01`) or a full ISO 8601 timestamp (`2026-08-01T00:00:00Z`). Requires `exited_phase_id`. On opportunities, combine with `exited_phase_id` set to a "Closed - Won"-style phase template to find deals that closed within a date range. - `order_by` (enum, optional, default: asc) — Sort order for results - Allowed values: `asc`, `desc` - `include_archived` (boolean, optional, default: false) — Whether to include archived (inactive) records in the response. By default only active records are returned. - `include_contacts` (boolean, optional, default: false) — Whether to include associated contacts in the response. Defaults to false unless explicitly set to true. - `include_phases` (boolean, optional, default: false) — Also return `phaseInstances` (every phase with its `status`, `startedAt` and `completedAt`) and `phase.startedAt` / `phase.completedAt` for the current phase, in the same shape as the single-record GET. Defaults to false. Adds two relation reads per row, so use a `page_size` of 25 or less when it is on. ## Response ### 200 List of opportunities matching filters - `list of OpportunityWithPhaseInstances` ## Errors ### 400 Bad Request Error Invalid request - `message` (string, optional) - `code` (enum, optional) - Allowed values: `UNAUTHORIZED` - `field` (string, optional) — Field that caused the validation error (if applicable) ### 401 Unauthorized Error Authentication failed - `message` (string, optional) - `code` (enum, optional) - Allowed values: `UNAUTHORIZED` ## Types ### OpportunityWithPhaseInstances - `ownerId` (integer, optional, nullable) — ID of the owning user - `salesRepId` (integer, optional, nullable) — ID of the assigned sales rep - `projectManagerId` (integer, optional, nullable) — ID of the assigned project manager - `address` (list of string, optional) — An array containing a single string, which represents the full opportunity location/address. - `trades` (list of enum, optional) — Array of trade types - Allowed values: `EV Charger`, `Solar`, `Storage`, `Boiler`, `Chiller`, `Ductwork`, `HVAC`, `Refrigeration`, `Electrical`, `Generator`, `Lighting`, `Gas Line`, `Plumbing`, `Water Filtration`, `Water Heater`, `Communications`, `Electronic Safety & Security`, `Integrated Automation`, `Insulation`, `Gutters`, `Roofing`, `Siding`, `Windows`, `Drywall`, `General Contracting`, `Home Improvement`, `Landscaping`, `R&R (Remove & Reinstall)`, `Tenant Improvement`, `Tree Cutting` - `value` (double, optional, nullable) — Deal value - `size` (double, optional, nullable) — Deal size - `confidence` (double, optional, nullable) — Deal confidence score (0-100) - `status` (enum, optional) — Status of the opportunity: * `ACTIVE` - Opportunity is open * `ON_HOLD` - Opportunity is temporarily paused * `WON` - Opportunity was won * `LOST` - Opportunity was lost - Allowed values: `ACTIVE`, `ON_HOLD`, `WON`, `LOST` - `workflowId` (integer, optional, nullable) — Associated workflow ID - `accountId` (integer, optional, nullable) — Associated account ID - `geoLocation` (list of string, optional) — Latitude/Longitude in "lat,lon" format. Read-only here — settable only via `PATCH /sites/{id}` on the linked site. - `imageUrl` (string, optional, nullable) — Image URL for the opportunity. Read-only — not settable via this API. - `streetViewUrl` (string, optional, nullable) — Street view image URL. Read-only — derived from geoLocation, not settable directly. - `city` (string, optional) - `zipcode` (string, optional) - `state` (string, optional) - `street` (string, optional) - `phaseTimeline` (list of OpportunityWithPhaseInstancesPhaseTimelineItems, optional) — Only present on `GET /opportunities` and `/opportunities/search` when `entered_phase_id`/`exited_phase_id` is used to filter the results. Contains the deal's full phase-transition history (not just the matched phase) in compact form — use `GET /opportunities/{opportunity_id}` for the complete `phaseInstances` with names, positions, and SLA info. - `owner` (OpportunityWithPhaseInstancesOwner, optional, nullable) - `salesRep` (OpportunityWithPhaseInstancesSalesRep, optional, nullable) - `projectManager` (OpportunityWithPhaseInstancesProjectManager, optional, nullable) - `jurisdiction` (OpportunityWithPhaseInstancesJurisdiction, optional, nullable) - `lastActivity` (string, optional, nullable) - `phaseId` (integer, optional, nullable) - `number` (integer, optional) — Sequential opportunity number - `workflowName` (string, optional) — Name of the associated workflow. - `contacts` (list of ContactRef, optional) — Contacts associated with this opportunity (independent of, and not inherited from, the parent account's contacts). Set on create or update via the `contacts` request field. On GET requests, only populated when include_contacts=true is passed. Always populated on POST (create) and PATCH (update) responses. Ordered with the primary contact first, capped at 20 contacts. - `phase` (OpportunityWithPhaseInstancesPhase, optional, nullable) — Current phase. `startedAt` and `completedAt` are present on `GET /opportunities/{opportunity_id}` and on lists with `include_phases=true`. - `phaseInstances` (list of OpportunityWithPhaseInstancesPhaseInstancesItems, optional) — Ordered list of phase instances for the opportunity. Returned by `GET /opportunities/{opportunity_id}`, and on lists and search with `include_phases=true`. ### OpportunityWithPhaseInstancesPhaseTimelineItems - `phaseTemplateId` (integer, optional) - `startedAt` (string, optional, nullable) — Timestamp when the deal entered this phase template - `completedAt` (string, optional, nullable) — Timestamp when the deal exited this phase template ### OpportunityWithPhaseInstancesOwner - `id` (integer, optional) - `firstName` (string, optional) - `lastName` (string, optional) - `email` (string, optional) - `phone` (string, optional, nullable) - `avatarUrl` (string, optional, nullable) ### OpportunityWithPhaseInstancesSalesRep - `id` (integer, optional) - `firstName` (string, optional) - `lastName` (string, optional) - `email` (string, optional) - `phone` (string, optional, nullable) - `avatarUrl` (string, optional, nullable) ### OpportunityWithPhaseInstancesProjectManager - `id` (integer, optional) - `firstName` (string, optional) - `lastName` (string, optional) - `email` (string, optional) - `phone` (string, optional, nullable) - `avatarUrl` (string, optional, nullable) ### OpportunityWithPhaseInstancesJurisdiction - `id` (integer, optional) - `name` (string, optional) - `uuid` (string, optional) ### ContactRef - `id` (integer, optional) - `name` (string, optional) - `title` (string, optional, nullable) — Contact title (e.g. job title) - `description` (string, optional, nullable) - `emails` (list of string, optional) - `phones` (list of string, optional) - `isPrimary` (boolean, optional) — True for the primary contact (the first contact in the list). At most one contact is primary. ### OpportunityWithPhaseInstancesPhase Current phase. `startedAt` and `completedAt` are present on `GET /opportunities/{opportunity_id}` and on lists with `include_phases=true`. - `id` (integer, optional) - `name` (string, optional) - `type` (string, optional) - `startedAt` (string, optional, nullable) - `completedAt` (string, optional, nullable) ### OpportunityWithPhaseInstancesPhaseInstancesItems - `id` (integer, optional) - `name` (string, optional) - `status` (enum, optional) - Allowed values: `NOT_STARTED`, `IN_PROGRESS`, `COMPLETED` - `position` (integer, optional) - `type` (string, optional) - `phaseTemplateId` (integer, optional) - `phaseTemplate` (PhaseTemplateSummary, optional) - `startedAt` (string, optional, nullable) — Timestamp when the phase instance started - `completedAt` (string, optional, nullable) — Timestamp when the phase instance completed ### PhaseTemplateSummary - `id` (integer, optional) - `name` (string, optional) - `type` (string, optional) - `redSla` (integer, optional, nullable) - `yellowSla` (integer, optional, nullable) ## Examples **Response** ```json [ { "ownerId": 1, "salesRepId": 1, "projectManagerId": 1, "address": [ "string" ], "trades": [ "EV Charger" ], "value": 1.1, "size": 1.1, "confidence": 1.1, "status": "ACTIVE", "workflowId": 1, "accountId": 1, "geoLocation": [ "string" ], "imageUrl": "string", "streetViewUrl": "string", "city": "string", "zipcode": "string", "state": "string", "street": "string", "phaseTimeline": [ { "phaseTemplateId": 1, "startedAt": "2024-01-15T09:30:00Z", "completedAt": "2024-01-15T09:30:00Z" } ], "owner": { "id": 1, "firstName": "string", "lastName": "string", "email": "string", "phone": "string", "avatarUrl": "string" }, "salesRep": { "id": 1, "firstName": "string", "lastName": "string", "email": "string", "phone": "string", "avatarUrl": "string" }, "projectManager": { "id": 1, "firstName": "string", "lastName": "string", "email": "string", "phone": "string", "avatarUrl": "string" }, "jurisdiction": { "id": 1, "name": "string", "uuid": "string" }, "lastActivity": "2024-01-15T09:30:00Z", "phaseId": 1, "number": 1, "workflowName": "string", "contacts": [ { "id": 1, "name": "string", "title": "string", "description": "string", "emails": [ "string" ], "phones": [ "string" ], "isPrimary": true } ], "phase": { "id": 1, "name": "string", "type": "string", "startedAt": "2024-01-15T09:30:00Z", "completedAt": "2024-01-15T09:30:00Z" }, "phaseInstances": [ { "id": 1, "name": "string", "status": "NOT_STARTED", "position": 1, "type": "string", "phaseTemplateId": 1, "phaseTemplate": { "id": 1, "name": "string", "type": "string", "redSla": 1, "yellowSla": 1 }, "startedAt": "2024-01-15T09:30:00Z", "completedAt": "2024-01-15T09:30:00Z" } ], "id": 1, "createdAt": "2024-01-15T09:30:00Z", "updatedAt": "2024-01-15T09:30:00Z", "title": "string", "description": "string", "isActive": true, "primaryEmail": "string", "primaryPhone": "string", "createdBy": { "id": 1, "firstName": "string", "lastName": "string", "email": "string", "avatarUrl": "string" }, "updatedBy": { "id": 1, "firstName": "string", "lastName": "string", "email": "string", "avatarUrl": "string" }, "custom": {} } ] ``` **SDK Code** ```python import requests url = "https://api.coperniq.io/v1/opportunities/search" querystring = {"prop1":"prop1","op1":"eq","value1":"value1"} headers = {"x-api-key": ""} response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript const url = 'https://api.coperniq.io/v1/opportunities/search?prop1=prop1&op1=eq&value1=value1'; const options = {method: 'GET', headers: {'x-api-key': ''}}; 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" "net/http" "io" ) func main() { url := "https://api.coperniq.io/v1/opportunities/search?prop1=prop1&op1=eq&value1=value1" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("x-api-key", "") 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://api.coperniq.io/v1/opportunities/search?prop1=prop1&op1=eq&value1=value1") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["x-api-key"] = '' 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://api.coperniq.io/v1/opportunities/search?prop1=prop1&op1=eq&value1=value1") .header("x-api-key", "") .asString(); ``` ```php request('GET', 'https://api.coperniq.io/v1/opportunities/search?prop1=prop1&op1=eq&value1=value1', [ 'headers' => [ 'x-api-key' => '', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.coperniq.io/v1/opportunities/search?prop1=prop1&op1=eq&value1=value1"); var request = new RestRequest(Method.GET); request.AddHeader("x-api-key", ""); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["x-api-key": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api.coperniq.io/v1/opportunities/search?prop1=prop1&op1=eq&value1=value1")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers 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() ```