Skip to main content
GET
Get an opportunity

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

Path Parameters

opportunity_id
string<uuid>
required

Response

Get an opportunity.

id
string<uuid>
required
name
string
required
pipeline_id
string<uuid>
required
pipeline_name
string
required
stage_id
string<uuid>
required
stage_name
string | null
required

Null when the stage was removed from the pipeline.

status
enum<string>
required
Available options:
open,
won,
lost
amount
number | null
required

A finite amount in the firm's currency. Null clears it.

Required range: x >= 0
probability
integer | null
required
Required range: 0 <= x <= 100
expected_close_date
string<date> | null
required
close_date
string<date> | null
required
assignee
object | null
required
contacts
object[]
required

Linked contacts the user can see.

households
object[]
required

Linked households the user can see.

created_on
string<date-time>
required
updated_on
string<date-time>
required
description
string | null
required

Markdown or plain text.

owner
object | null
required
creator
object | null
required
tags
object[]
required