Skip to main content
GET
Retrieve one opportunity
Learn more:
  • What is an opportunity? ↗

Path Parameters

consumer_id
string<uuid>
required
opportunity_id
string
required

Response

Successful Response

id
string
required

Technical id in Chift

Example:

"<this-id>"

source_ref
Ref · object
required

Technical id in the target software

name
string
required

Name

Example:

"New business opportunity"

total
number
required

Total

Example:

1000

probability
number
required

Probability of success

Example:

50

status
enum<string>
required

Status

Available options:
open,
won,
lost,
cancelled,
closed
partner_id
string | null

Technical id of the customer in Chift

Example:

"<invoicing-partner-id>"

comment
string | null

Comment

Example:

"Follow up next week."

currency
string | null

Currency matching target sofware name

Example:

"EUR"

description
string | null

Description

Example:

"Potential new client."

pipe_status
string | null

Current stage in pipeline

Example:

"Qualification"

pipe_name
string | null

Pipeline name

Example:

"Sales pipeline"

created_date
string<date> | null

Date creation

Example:

"2026-01-15"

due_date
string<date> | null

Due Date

Example:

"2026-02-14"

end_date
string<date> | null

End Date

Example:

"2026-02-28"

is_won
boolean | null

Is won?

owner_ref
FieldRef · object | null

Employee/User