Opportunities

Get an opportunity

get/opportunities/{id}

Request

  • Base URL: https://www.ruddr.io/api/workspace
  • URL: https://www.ruddr.io/api/workspace/opportunities/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The opportunity uuid

Response

200

idstring

The unique identifier for the object.

namestring

The name of the opportunity.

descriptionstring nullable

A description of the opportunity.

nextStepsstring nullable

The next steps for the opportunity.

amountnumber nullable

The monetary amount of the opportunity.

probabilitynumber

The probability of the opportunity closing successfully, expressed as a decimal between 0 and 1.

priorityId'high' | 'medium' | 'low' nullable

The priority level of the opportunity.

createdAtstring date-time

The timestamp when the object was created.

openDatestring date

The date the opportunity was opened. Will be in the form YYYY-MM-DD.

closeDatestring date nullable

The expected close date for the opportunity. Will be in the form YYYY-MM-DD.

modifiedAtstring date-time

The timestamp when the object was last modified.

currencystring

The 3-letter currency code for the opportunity.

cloudFolderUrlstring nullable

A URL to a cloud folder associated with the opportunity.

weightedAmountnumber nullable

The probability-weighted amount, calculated as amount multiplied by probability.

timeSpentinteger

Total time spent in minutes across all pipeline activities.

salesforceIdstring nullable

The Salesforce opportunity ID. Will be null unless synced via the Salesforce integration.

hubspotIdstring nullable

The HubSpot deal ID. Will be null unless synced via the HubSpot integration.

Changes

No recorded changes to this operation across all 1 revision of this API.