Retrieve an opportunity

GET

https://api.close.com/api/v1/opportunity/:id/

GET

/api/v1/opportunity/:id/

curl https://api.close.com/api/v1/opportunity/id/ \
     -u "<CLOSE_API_KEY>:"

{
  "annualized_expected_value": 37500,
  "annualized_value": 50000,
  "confidence": 75,
  "contact_id": null,
  "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "date_created": "2013-02-01T00:54:51.337000+00:00",
  "date_lost": null,
  "date_updated": "2013-02-01T00:54:51.337000+00:00",
  "date_won": null,
  "expected_value": 37500,
  "id": "oppo_8eB77gAdf8FMy6GsNHEy84f7uoeEWv55slvUjKQZpJt",
  "lead_id": "lead_IIDHIStmFcFQZZP0BRe99V1MCoXWz2PGCm6EDmR9v2O",
  "note": "Bruce needs new software for the Bat Cave.",
  "note_html": "<body><p>Bruce needs new software for the Bat Cave.</p></body>",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "status_id": "stat_4ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk",
  "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "value": 50000,
  "value_period": "one_time",
  "lead_name": "Wayne Enterprises (Sample Lead)",
  "pipeline_id": "pipe_04fC628PVB0HjK2Qq5EqEf",
  "pipeline_name": "Sales",
  "status_label": "Active",
  "status_type": "active",
  "user_name": "John Doe",
  "value_currency": "USD",
  "value_formatted": "$500",
  "custom.cf_j0P7kHmgFTZZnYBFtyPSZ3uQw4dpW8xKcW7Krps8atj": "https://www.example.com/contract.pdf"
}

Authentication

AuthorizationBasic

Use your API key as the username and leave the password empty.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Query parameters

_fieldsstringOptional

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

Response

Successful response

annualized_expected_valueinteger or null

Annualized expected value in cents.

annualized_valueinteger or null

Annualized value in cents.

confidenceinteger

contact_idstring or null

created_bystring or null

date_createddatetime

date_lostdatetime or null

date_updateddatetime

date_wondate or null

expected_valueinteger or null

Value multiplied by confidence, in cents.

idstring

lead_idstring

notestring or null

note_htmlstring or null

organization_idstring

status_idstring

updated_bystring or null

user_idstring

valueinteger or null

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

value_periodenum

Allowed values:

attachmentslist of objectsOptional

comment_summaryobject or nullOptional

contact_namestring or nullOptional

created_by_agent_idstring or nullOptional

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

created_by_namestring or nullOptional

integration_linkslist of objectsOptional

is_stalledbooleanOptional

lead_namestring or nullOptional

lead_primary_emailobject or nullOptional

lead_primary_phonelist of objects or nullOptional

pipeline_idstring or nullOptional

pipeline_namestring or nullOptional

stall_statusobject or nullOptional

status_display_namestringOptional

status_labelstringOptional

status_typeenumOptional

Allowed values:

suggested_actionobject or nullOptional

updated_by_agent_idstring or nullOptional

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

updated_by_namestring or nullOptional

user_namestring or nullOptional

value_currencystring or nullOptional

value_formattedstring or nullOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error