Skip to main content
GET
List opportunities

Authorizations

Authorization
string
header
required

OAuth 2.0 authorization code flow with PKCE (S256). See the authorization guide.

Scopes

opportunities:read

Read your opportunities and your firm's pipelines

Query Parameters

page
integer
default:1

The page number to return, from 1 to 1,000. This is separate from the records-per-page limit.

Required range: 1 <= x <= 1000
limit
integer
default:50

Records per page, at most 100.

Required range: 1 <= x <= 100
pipeline_id
string<uuid>
stage_id
string<uuid>
assignee_id
string<uuid>
contact_id
string<uuid>
household_id
string<uuid>
status
enum<string>
Available options:
open,
won,
lost
query
string

Every word must appear in the opportunity name.

Maximum string length: 200

Response

List opportunities.

page
integer
required
Required range: 1 <= x <= 1000
limit
integer
required
Required range: 1 <= x <= 100
has_more
boolean
required

Whether the next page has rows.

data
object[]
required