OPPORTUNITIES

Fetches known opportunity competitors.

GET/api/v2/opportunities/competitors

Authentication

Choose one supported method for this request.

OAuth 2.0 client credentials

Responses

Competitors retrieved successfully.

Standard response envelopeisSuccessmessageerrorsdata

Read the result from data. When isSuccess is false, errors lists what went wrong. Handling errors

An array. Each item is a OpportunityCompetitorDto:

competitorIdinteger · int32
recordTypestring
recordIdinteger · int32
competitorNamestring
makestring
modelstring
serialNostring
equipYearstring
hoursinteger · int32
attachmentsstring
optionsstring
additionalEquipmentstring
commentsstring
quotedPricenumber · double
ratenumber · double
termsstring
paymentnumber · double
wonAgainstboolean
lostToboolean
rentalIntervalstring
rentalRatenumber · double
rentalDurationinteger · int32

REQUEST EXAMPLE

curl --request GET \
  'https://apiv2.crmseries.com/api/v2/opportunities/competitors' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace the uppercase placeholders and sample values with your integration values.

RESPONSE · 200

{
  "isSuccess": true,
  "message": "",
  "data": [
    {
      "competitorId": 1024,
      "recordType": "string",
      "recordId": 1024,
      "competitorName": "string",
      "make": "Caterpillar",
      "model": "320",
      "serialNo": "CAT0320XABC12345",
      "equipYear": "string",
      "hours": 3250,
      "attachments": "string",
      "options": "string",
      "additionalEquipment": "string",
      "comments": "string",
      "quotedPrice": 125000.5,
      "rate": 125000.5,
      "terms": "string",
      "payment": 125000.5,
      "wonAgainst": true,
      "lostTo": false,
      "rentalInterval": "string",
      "rentalRate": 125000.5,
      "rentalDuration": 1
    }
  ],
  "errors": []
}