Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

SalesOpportunities

Get a list of sales opportunities

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

get/v1/finance/salesOpportunities

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>

Example:creationDate

The field to sort items in the page by

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>

Example:ascending

The direction to apply the sort

idinteger[]

Only return sales opportunities where id matches the value(s) provided (Max items: 50)

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>

Example:created

Only return sales opportunities with the specified status

contactIdinteger

Only return sales opportunities where contactId matches the value provided

ownerIdinteger

Only return sales opportunities where ownerId matches the value provided

referencestring

Only return sales opportunities where reference starts with the value provided

createdAtFromstring date-time

Only return sales opportunities created at or after this date (inclusive)

createdAtTostring date-time

Only return sales opportunities created at or before this date (inclusive)

dueDateFromstring date-time

Only return sales opportunities with a due date at or after this date (inclusive)

dueDateTostring date-time

Only return sales opportunities with a due date at or before this date (inclusive)

pageNumberinteger

The page number being requested (minimum: 1, maximum: 2147483)

pageSizeinteger

The page size being requested (minimum: 1, maximum: 1000)

Headers

Customer-Idinteger required

The customer identifier

Response

OK

pageNumberinteger

The page number of the response where 1 is the first page

pageSizeinteger

The number of items requested for the current page

pageItemCountinteger

The number of items returned in the current page

Example response

{
  "items": [
    {
      "id": 12345,
      "contactId": 67890,
      "subject": "New office equipment deal",
      "status": "created",
      "dueAt": "2025-06-30T00:00:00.0000000+00:00",
      "stageId": 3,
      "probabilityId": 2,
      "ownerId": 456,
      "ownerName": "Jane Smith",
      "notes": "Customer is interested in bulk pricing",
      "reference": "SO-2025-001",
      "createdAt": "2025-01-15T09:30:00.0000000+00:00",
      "customFields": [
        {
          "definitionId": 5514123,
          "value": "Purple",
          "definition": {
            "caption": "Favourite colour",
            "type": "boolean",
            "listOptions": [
              "Red",
              "Blue",
              "Green",
              "Purple"
            ],
            "isRequired": true,
            "isEditable": true,
            "default": "10"
          },
          "systemListValueMetadata": {
            "label": "John Doe",
            "entityType": "resource"
          }
        }
      ]
    }
  ],
  "pageNumber": 2,
  "pageSize": 100,
  "pageItemCount": 55
}