COMPANY

Fetches opportunities for a specific company with pagination.

GET/api/v2/companies/{companyId}/opportunities

Authentication

Choose one supported method for this request.

OAuth 2.0 client credentials

Parameters

companyIdpathinteger · int32required

The ID of the company to retrieve opportunities for.

statusquerystring

All/LostSale/LostRental

pagequeryinteger · int32

Page number.

pageSizequeryinteger · int32

Number of items per page.

Responses

Company opportunities retrieved successfully.

Standard response envelopeisSuccessmessageerrorsdata

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

Paginated

totalCountinteger · int32
- opportunityIdinteger · int32
- userIdinteger · int32
- userstring
- equipmentIdinteger · int32
- companyIdinteger · int32
- companyNamestring
- contactIdinteger · int32
- contactstring
- statusIdinteger · int32
- statusstring
- internalResultstring
- groupIdinteger · int32
- groupstring
- namestring
- amountnumber · double
- closeDatestring · datenullable
- probabilitynumber · double
- deletedboolean
- openDatestring · date
- branchIdinteger · int32
- branchstring
- lostSaleboolean
- saleTypeIdinteger · int32
- saleTypestring
- transactionTypeIdinteger · int32
- transactionTypestring
- makestring
- modelstring
- serialNostring
- stockNostring
- yearstring
- hoursinteger · int32
- qtyinteger · int32
- attachmentsstring
- optionsstring
- additionalEquipmentstring
- commentsstring
- decisionDatestring · datenullable
- deliveryDatestring · datenullable
- deliveryStatestring
- deliveryCountystringnullable
- decisionCommentsstring
- expirationDatestring · datenullable
- referenceNostring
- lostRentalboolean
- rentalRatenumber · double
- rentalIntervalstring
- rentalDurationinteger · int32
pageCountinteger · int32
currentPageCountinteger · int32
nextPageNumberinteger · int32nullable
hasNextPageboolean

REQUEST EXAMPLE

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

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

RESPONSE · 200

{
  "isSuccess": true,
  "message": "",
  "data": {
    "totalCount": 42,
    "data": [
      {
        "opportunityId": 1024,
        "userId": 1024,
        "user": "string",
        "equipmentId": 1024,
        "companyId": 1024,
        "companyName": "Acme Equipment Co.",
        "contactId": 1024,
        "contact": "string",
        "statusId": 1024,
        "status": "string",
        "internalResult": "string",
        "groupId": 1024,
        "group": "string",
        "name": "string",
        "amount": 125000.5,
        "closeDate": "2026-01-15",
        "probability": 1.5,
        "deleted": false,
        "openDate": "2026-01-15",
        "branchId": 1024,
        "branch": "string",
        "lostSale": false,
        "saleTypeId": 1024,
        "saleType": "string",
        "transactionTypeId": 1024,
        "transactionType": "string",
        "make": "Caterpillar",
        "model": "320",
        "serialNo": "CAT0320XABC12345",
        "stockNo": "STK-1001",
        "year": "string",
        "hours": 3250,
        "qty": 1,
        "attachments": "string",
        "options": "string",
        "additionalEquipment": "string",
        "comments": "string",
        "decisionDate": "2026-01-15",
        "deliveryDate": "2026-01-15",
        "deliveryState": "string",
        "deliveryCounty": "string",
        "decisionComments": "string",
        "expirationDate": "2026-01-15",
        "referenceNo": "string",
        "lostRental": false,
        "rentalRate": 125000.5,
        "rentalInterval": "string",
        "rentalDuration": 1,
        "assignedReasons": [
          {
            "assignedId": 1024,
            "parentType": "string",
            "parentId": 1024,
            "reasonId": 1024,
            "reason": "string"
          }
        ],
        "udfs": [
          {
            "assignedId": 1024,
            "fieldName": "string",
            "displayText": "string",
            "recordType": "string",
            "recordId": 1024,
            "udfID": 1024,
            "lookupId": 1024,
            "stringValue": "string",
            "dateValue": "2026-01-15",
            "numericValue": 125000.5,
            "booleanValue": true
          }
        ],
        "competitors": [
          {
            "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
          }
        ],
        "recordAccessRights": {
          "exists": true,
          "view": true,
          "edit": true,
          "delete": true,
          "addNote": true
        }
      }
    ],
    "pageCount": 42,
    "currentPageCount": 42,
    "nextPageNumber": 1,
    "hasNextPage": true
  },
  "errors": []
}