Skip to main content
GET
Get a full opportunity record by UUID.

Authorizations

x-api-key
string
header
required

Path Parameters

opportunity_uuid
string
required

Query Parameters

include_custom_field_mapping
boolean
default:true

Set false to leave the deprecated custom_field_mapping schema off the response. Get it from GET /v1/opportunities/custom-fields instead. Defaults to true for backwards compatibility.

Response

200 - application/json

Single-opportunity response (GET /v1/opportunities/{uuid}).

Extends OpportunityResponse with the tenant's custom-field schema, which is only computed once per response here — list responses instead carry it once at the top level (OpportunityListResponse.custom_field_mapping) rather than repeating it on every item.

uuid
string
required
associations
OpportunityAssociation · object[] | null
children_metadata
OpportunityMetadata · object | null
close_date
string | null
company_last_activity_date
string | null
created_at
number | null
created_by
RelatedPerson · object | null
custom_field_mapping
CustomFieldMapping · object | null
deprecated

Deprecated: fetch the schema once from GET /v1/opportunities/custom-fields instead, and pass include_custom_field_mapping=false to leave it off this response. Each custom_fields entry already carries its field's name and type. Null when excluded.

custom_fields
OpportunityCustomFieldValue · object[]
days_in_stage
integer | null
details
string | null
intro_date
string | null
intro_person
RelatedPerson · object | null
last_activity_date
string | null
name
string | null
next_meeting_at
string | null
next_step
string | null
notes_and_files_count
integer | null
owner
RelatedPerson · object | null
parent_name
string | null
parent_uuid
string | null
person_last_activity_date
string | null
probability
integer | null
source_date
string | null
stage
OpportunityStageOnRecord · object | null
type
OpportunityTypeOnRecord · object | null
updated_at
number | null
updated_by
RelatedPerson · object | null
value
integer | null
weighted_value
integer | null