---
title: "GET /opportunity"
method: GET
path: "/opportunity"
tags: ["opportunity"]
---

# GET /opportunity

`GET /opportunity`

## Request

- Base URL: `https://www.weclapp.com/api/nullapi/v2`
- URL: `https://www.weclapp.com/api/nullapi/v2/opportunity`
- Auth: API key in header `AuthenticationToken`
- TypeScript: <https://skmtc.dev/weclapp/apis/weclapp-api/docs/opportunity/get.ts> (a function with typed inputs; its response is checked against the schema)

query opportunity

## Query parameters

- `page` integer
- `pageSize` integer
- `sort` string

## Response `200`

opportunity response

- object
  - `result` Opportunity[]
    - `id` string
    - `version` string
    - `contactId` string
    - `createdDate` integer
    - `creatorId` string
    - `customAttributes` CustomAttribute[]
      - `attributeDefinitionId` string
      - `booleanValue` boolean
      - `dateValue` integer
      - `entityId` string
      - `entityReferences` EntityReference[]
        - `entityId` string
        - `entityName` string
      - `numberValue` string, number
      - `selectedValueId` string
      - `selectedValues` OnlyId[]
        - `id` string
      - `stringValue` string
    - `customerId` string, required
    - `description` string
    - `expectedDeliveryDate` integer
    - `expectedSignatureDate` integer
    - `hotLead` boolean
    - `lastModifiedDate` integer
    - `name` string, required
    - `nextCallDate` integer
    - `opportunityNumber` string
    - `responsibleUserId` string
    - `revenue` string, number
    - `salesChannel` string
    - `salesProbability` integer, required
    - `salesStageHistory` SalesStageHistory[]
      - `id` string
      - `version` string
      - `createdDate` integer
      - `lastModifiedDate` integer
      - `salesStageId` string
      - `userId` string
    - `salesStageId` string, required
    - `startDate` integer
    - `tags` string[]
    - `topics` OnlyId[]
      - `id` string
    - `winLossDescription` string
    - `winLossReasonId` string

## Other responses

- `default`: error response

---

[API](https://skmtc.dev/weclapp/apis/weclapp-api.md) - [All operations](https://skmtc.dev/weclapp/apis/weclapp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/weclapp/apis/weclapp-api/revisions/0e021229755d?raw)