COcopper
Opportunities

Get opportunity by ID

Retrieve a specific opportunity by their ID. This endpoint is eligible to return computed custom field values.

get/opportunities/{id}

Request

  • Base URL
    https://api.copper.com/developer_api/v1
  • Auth
    HTTP bearer

Path parameters

idinteger required

Opportunity ID

Query parameters

custom_field_computed_valuesboolean

When true, returns computed custom field values (human-readable labels) in addition to option IDs for Dropdown and Multi-select fields. The response will include a 'computed_value' field alongside the 'value' field in custom_fields array.

Response

Opportunity retrieved successfully

idinteger required

Unique identifier for the opportunity

namestring required

The name of the opportunity

assignee_idinteger nullable

Unique identifier of the user that will be the owner of the opportunity

close_dateinteger nullable

The expected close date of the opportunity (Unix timestamp)

company_idinteger nullable

The unique identifier of the primary company with which the opportunity is associated

company_namestring nullable

The name of the primary company with which the opportunity is associated

customer_source_idinteger nullable

Unique identifier of the customer source that generated this opportunity

detailsstring nullable

Description of the opportunity

loss_reason_idinteger nullable

If the opportunity's status is 'Lost', the unique identifier of the loss reason that caused this opportunity to be lost

monetary_valuenumber nullable

The monetary value of the opportunity

pipeline_idinteger

The unique identifier of the pipeline in which this opportunity is

pipeline_is_revenueboolean

The revenue type of the pipeline associated with the opportunity

pipeline_stage_idinteger

The unique identifier of the pipeline stage of the opportunity

pipeline_type'opportunity' | 'project' | 'item'

The type of the pipeline ('opportunity', 'project', or 'item') associated with the opportunity

primary_contact_idinteger nullable

The unique identifier of the person who is the primary contact for this opportunity

priority'None' | 'Low' | 'Medium' | 'High'

The priority of the opportunity

status'Open' | 'Won' | 'Lost' | 'Abandoned'

The status of the opportunity

tagsstring[]

An array of the tags associated with the opportunity

win_probabilityinteger

The expected probability of winning the opportunity. Valid values are [0-100] (inclusive)

interaction_countinteger

The number of interactions with this opportunity

date_createdinteger

A Unix timestamp representing the time at which this opportunity was created

date_modifiedinteger

A Unix timestamp representing the time at which this opportunity was last modified

Example response

{
  "id": 2827698,
  "name": "8 New Copy Machines (sample)",
  "close_date": 1484899200,
  "company_id": 9607580,
  "company_name": "Dunder Mifflin (sample)",
  "customer_source_id": 331241,
  "details": "Opportunities are created for People and Companies that are interested in buying your products or services.",
  "monetary_value": 250000,
  "pipeline_id": 213214,
  "pipeline_stage_id": 987790,
  "pipeline_type": "opportunity",
  "priority": "None",
  "status": "Open",
  "tags": [],
  "win_probability": 5,
  "date_created": 1483988829,
  "date_modified": 1489018922,
  "custom_fields": [
    {
      "custom_field_definition_id": 100764
    }
  ]
}

Changes

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