List opportunities

GET /v4/core/companies/{companyId}/opportunities

List opportunities

cURL

curl --request GET \
  --url https://api.integrations.commenda.io/v4/core/companies/{companyId}/opportunities \
  --header 'api_key: <api-key>'

import requests

url = "https://api.integrations.commenda.io/v4/core/companies/{companyId}/opportunities"

headers = {"api_key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {api_key: '<api-key>'}};

fetch('https://api.integrations.commenda.io/v4/core/companies/{companyId}/opportunities', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.integrations.commenda.io/v4/core/companies/{companyId}/opportunities",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "api_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.integrations.commenda.io/v4/core/companies/{companyId}/opportunities"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api_key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.integrations.commenda.io/v4/core/companies/{companyId}/opportunities")
  .header("api_key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.integrations.commenda.io/v4/core/companies/{companyId}/opportunities")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "data": {
    "data": [
      {
        "rootfi_id": 123,
        "rootfi_created_at": "2023-11-07T05:31:56Z",
        "rootfi_updated_at": "2023-11-07T05:31:56Z",
        "platform_id": "<string>",
        "name": "<string>",
        "account_id": "<string>",
        "contact_id": "<string>",
        "pipeline_id": "<string>",
        "pipeline_stage_id": "<string>",
        "owner_id": "<string>",
        "amount": 123,
        "probability": 123,
        "close_date": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "last_activity_at": "2023-11-07T05:31:56Z"
      }
    ],
    "total_count": 123,
    "next": "<string>",
    "prev": "<string>"
  },
  "request_id": "<string>"
}

Authorizations

api_key · string · header · required

Your Commenda Integrations API key, sent in the api_key header.

Path Parameters

companyId · integer · required

Commenda company id.

Query Parameters

limit · integer · default: 20

Max records to return.

Required range: x <= 100

next · string

Cursor for the next page (from a previous response).

prev · string

Cursor for the previous page.

include_deleted_records · boolean

Include soft-deleted records.

return_count · boolean

Include the total match count in the response.

name[eq] · string

Exact match on name.

name[in] · string

Comma-separated name values (OR match).

status[eq] · enum<string>

Exact match on status.

Available options: OPEN, WON, LOST

status[in] · string

Comma-separated status values (OR match).

pipeline_stage_id[eq] · string

Exact match on pipeline_stage_id.

pipeline_stage_id[in] · string

Comma-separated pipeline_stage_id values (OR match).

pipeline_id[eq] · string

Exact match on pipeline_id.

pipeline_id[in] · string

Comma-separated pipeline_id values (OR match).

account_id[eq] · string

Exact match on account_id.

account_id[in] · string

Comma-separated account_id values (OR match).

contact_id[eq] · string

Exact match on contact_id.

contact_id[in] · string

Comma-separated contact_id values (OR match).

owner_id[eq] · string

Exact match on owner_id.

owner_id[in] · string

Comma-separated owner_id values (OR match).

currency_id[eq] · enum<string>

Exact match on currency_id.

Available options: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG

currency_id[in] · string

Comma-separated currency_id values (OR match).

rootfi_updated_at[eq] · string

Exact match on rootfi_updated_at.

rootfi_updated_at[in] · string

Comma-separated rootfi_updated_at values (OR match).

rootfi_updated_at[gte] · string

rootfi_updated_at greater-than-or-equal.

rootfi_updated_at[lte] · string

rootfi_updated_at less-than-or-equal.

Response

200 - application/json

A paginated list of opportunities.

data · object · required

Show child attributes

request_id · string · required