Skip to main content
GET
List opportunities

Authorizations

Authorization
string
header
required

Partner OAuth2 flows for integration API access tokens. Claude MCP custom connectors use authorization code with PKCE S256.

Headers

X-Organization-Id
string<uuid>

Active organization UUID. Required for authenticated requests when the principal has access to multiple organizations.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

Query Parameters

organizationId
string<uuid>

Read-only convenience alias for X-Organization-Id. Legacy subscriberId query param is also accepted.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
limit
integer
default:50
Required range: 1 <= x <= 200
cursor
string
page
integer
default:1
Required range: x >= 1
pageSize
integer
default:50
Required range: 1 <= x <= 200
sortBy
string
order
enum<string>
default:asc
Available options:
asc,
desc
partnerId
string<uuid>

Filter by partner account UUID (UI "Partner Name").

buyingGroupId
string<uuid>
showClosed
boolean
default:false
sharedWithMe
boolean
period
string
from
string<date>
to
string<date>
minAmount
string
maxAmount
string

Response

Opportunity list.

data
object[]
required
pagination
object
required