---
title: "Get a list of sales opportunities"
method: GET
path: "/v1/finance/salesOpportunities"
tags: ["SalesOpportunities"]
---

# Get a list of sales opportunities

`GET /v1/finance/salesOpportunities`

## Request

- Base URL: `https://api.bigchange.com`
- URL: `https://api.bigchange.com/v1/finance/salesOpportunities`
- Auth: HTTP bearer

Retrieve a paged collection of sales opportunities (required scope finance:read)

## Query parameters

- `sortBy` 'creationDate' | 'subject' | 'dueDate' | 'reference': Sort options for sales opportunities.<p>Possible values:</p><ul><li><b>creationDate</b>: Sort by creation date.</li><li><b>subject</b>: Sort by subject.</li><li><b>dueDate</b>: Sort by due date.</li><li><b>reference</b>: Sort by reference.</li></ul>
- `direction` 'ascending' | 'descending': Represents the direction in which sorting should be applied<p>Possible values:</p><ul><li><b>ascending</b>: Indicates ascending sorting order</li><li><b>descending</b>: Indicates descending sorting order</li></ul>
- `id` integer[]
- `status` 'created' | 'onHold' | 'completedWon' | 'completedLost': Represents the status of a sales opportunity.<p>Possible values:</p><ul><li><b>created</b>: The sales opportunity has been created.</li><li><b>onHold</b>: The sales opportunity is on hold.</li><li><b>completedWon</b>: The sales opportunity has been completed and won.</li><li><b>completedLost</b>: The sales opportunity has been completed and lost.</li></ul>
- `contactId` integer
- `ownerId` integer
- `reference` string
- `createdAtFrom` string, date-time
- `createdAtTo` string, date-time
- `dueDateFrom` string, date-time
- `dueDateTo` string, date-time
- `pageNumber` integer
- `pageSize` integer

## Headers

- `Customer-Id` integer, required

## Response `200`

OK

- PagedResponseReadSalesOpportunityModel: A paged collection of items
  - `items` ReadSalesOpportunityModel[]: The items returned for the requested page
    - `id` integer: The unique identifier of the sales opportunity
    - `contactId` integer: The identifier of the contact associated with the sales opportunity
    - `subject` string: The subject of the sales opportunity
    - `status` 'created' | 'onHold' | 'completedWon' | 'completedLost': Represents the status of a sales opportunity.<p>Possible values:</p><ul><li><b>created</b>: The sales opportunity has been created.</li><li><b>onHold</b>: The sales opportunity is on hold.</li><li><b>completedWon</b>: The sales opportunity has been completed and won.</li><li><b>completedLost</b>: The sales opportunity has been completed and lost.</li></ul>
    - `dueAt` string, date-time, nullable: The due date of the sales opportunity
    - `stageId` integer: The identifier of the stage associated with the sales opportunity
    - `probabilityId` integer: The identifier of the probability associated with the sales opportunity
    - `ownerId` integer: The identifier of the owner of the sales opportunity
    - `ownerName` string: The name of the owner of the sales opportunity
    - `notes` string, nullable: Notes associated with the sales opportunity
    - `reference` string, nullable: The reference for the sales opportunity
    - `createdAt` string, date-time: The date the sales opportunity was created
    - `customFields` CustomFieldReadModel[]: Custom fields associated with the sales opportunity
      - `definitionId` integer: The unique identifier of the associated custom field definition
      - `value` string, nullable: The current value set for the custom field
      - `definition` CustomFieldEmbeddedDefinitionModel: Represents the definition of a custom field
        - `caption` string: The caption of a custom field
        - `type` 'boolean' | 'integer' | 'decimal' | 'text' | 'list' | 'statement' | 'date' | 'note' | 'time' | 'systemList': The type of the custom field. New field types may be added in the future, so integrations should be resilient to this<p>Possible values:</p><ul><li><b>boolean</b>: Indicates a boolean field <i>(Example: "false")</i></li><li><b>integer</b>: Indicates an integer numeric field <i>(Example: "1001")</i></li><li><b>decimal</b>: Indicates a floating point numeric field <i>(Example: "1.42")</i></li><li><b>text</b>: Indicates an editable text field <i>(Example: "Purple")</i></li><li><b>list</b>: Indicates a field with a single value from a predefined list of options <i>(Example: "Purple")</i></li><li><b>statement</b>: Indicates a text field that cannot be edited. The value is always equal to the default value <i>(Example: "By signing this you agree to the following...")</i></li><li><b>date</b>: Indicates a date field, which will be represented as an RFC3339 formatted date string. The default value is not supported for this type and will always be null <i>(Example: "2024-01-31")</i></li><li><b>note</b>: Indicates a multiline, editable text field. Lines are seperated with a line feed character <i>(Example: "This is a note.")</i></li><li><b>time</b>: Indicates a time field, formatted as HH:mm. The default value is not supported for this type and will always be null <i>(Example: "10:30")</i></li><li><b>systemList</b>: Indicates the ID of a related resource, vehicle or web user <i>(Example: "228007")</i></li></ul>
        - `listOptions` string[], nullable: Shows the possible values for a list type custom field. Value will be null if type is not list
        - `isRequired` boolean: Indicates if the field is required in the UI. This is NOT enforced in the API
        - `isEditable` boolean: Indicates if the field is editable
        - `default` string, nullable: The default value of a custom field. Formatted in accordance with the rules of the field type
      - `systemListValueMetadata` SystemListValueMetadataModel: Represents details of custom field value of type system list
        - `label` string, nullable: A descriptive label for the specific resource, vehicle or web user that this system list value relates to
        - `entityType` 'resource' | 'vehicle' | 'webUser': The type of entity used for custom field value of type system list<p>Possible values:</p><ul><li><b>resource</b></li><li><b>vehicle</b></li><li><b>webUser</b></li></ul>
  - `pageNumber` integer: The page number of the response where 1 is the first page
  - `pageSize` integer: The number of items requested for the current page
  - `pageItemCount` integer: The number of items returned in the current page

## Other responses

- `400`: Bad Request
- `422`: Unprocessable Content
- `500`: Internal Server Error

## Changes

- **2026-10-29** `5306509f5616`: 1 info
  - added the non-success response with the status `422`

[Operation history](https://skmtc.dev/bigchange/apis/bigchange-dx/changes/v1/finance/salesOpportunities/get.md)

---

[API](https://skmtc.dev/bigchange/apis/bigchange-dx.md) - [All operations](https://skmtc.dev/bigchange/apis/bigchange-dx/llms.txt) - [OpenAPI document](https://skmtc.dev/bigchange/apis/bigchange-dx/revisions/b262bfdb1dd0?raw)