Skip to main content
GET
List opportunities

Authorizations

Authorization
string
header
required

The organization API key, sent as Authorization: Bearer <key>.

Query Parameters

limit
integer
default:25

How many items to return. Maximum 100.

Required range: 1 <= x <= 100
Example:

25

offset
integer | null
default:0

How many items to skip from the beginning.

Required range: x >= 0
Example:

0

query
string

Matches against the title, short reference and destination.

Minimum string length: 1
salesStage
string
Minimum string length: 1
stageId
string

Id of a pipeline column, to fetch just that stage.

Minimum string length: 1

Response

The requested page.

data
object[]
required
pagination
object
required