Nested Opportunity Model

Represents a reference to an opportunity. By default, contains only the id and name.

If the field is included in the embed parameter will instead be a full Opportunity object. If the opportunity is restricted for the user calling the API endpoint the full Opportunity object is not included.

Name Type Description
id Long Read only

The unique id of the opportunity

name String Read only

The name of the opportunity. This will contain Private when the user calling the API endpoint doesn't have access to the opportunity record.

isRestricted Boolean Read only

Defines whether this opportunity is restricted for the user calling the API endpoint.