CLclose
opportunities

Retrieve an opportunity

Changed on
get/opportunity/{id}/

Request

  • Base URL
    https://api.close.com/api/v1
  • URL
    https://api.close.com/api/v1/opportunity/{id}/
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://app.close.com/oauth2/authorize/
      Token URL: https://api.close.com/oauth2/token/

Path parameters

idstring required

Query parameters

_fieldsstring

Comma-separated list of fields to include in the response.

Response

Successful response

annualized_expected_valueinteger nullable required

Annualized expected value in cents.

annualized_valueinteger nullable required

Annualized value in cents.

confidenceinteger required
contact_idstring nullable required
contact_namestring nullable
created_bystring nullable required
created_by_agent_idstring nullable

ID of the agent that created the opportunity, or null if no agent created it.

created_by_namestring nullable
date_createdstring date-time required
date_loststring date-time nullable required
date_updatedstring date-time required
date_wonstring date nullable required
expected_valueinteger nullable required

Value multiplied by confidence, in cents.

idstring required
is_stalledboolean
lead_idstring required
lead_namestring nullable
notestring nullable required
note_htmlstring nullable required
organization_idstring required
pipeline_idstring nullable
pipeline_namestring nullable
status_display_namestring
status_idstring required
status_labelstring
status_type'won' | 'lost' | 'active'
updated_bystring nullable required
updated_by_agent_idstring nullable

ID of the agent that last updated the opportunity, or null if the last update wasn't made by an agent.

updated_by_namestring nullable
user_idstring required
user_namestring nullable
valueinteger nullable required

Monetary value of the opportunity in cents, e.g. 340000 for $3,400.00. See value_formatted for a human-readable version.

value_currencystring nullable
value_formattedstring nullable
value_period'one_time' | 'monthly' | 'annual' required

Changes

  • 8e360c61058cRevision changes
    • info

      added the pattern property ^custom\.(cf|lcf|ccf|acf|gcf|scf)_[A-Za-z0-9]+$ to the response body for the status

  • 784846be4a00Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status