Skip to content

Fetch an Opportunity by ID

GET https://api.copper.com/developer_api/v1/opportunities/{{example_opportunity_id}}

Note that this endpoint is eligible to return computed custom field values, click here for more information.

Example Requests

Get Opportunity

1
2
3
4
5
curl --location --request GET "https://api.copper.com/developer_api/v1/opportunities/{{example_opportunity_id}}" \
  --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \
  --header "X-PW-Application: developer_api" \
  --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \
  --header "Content-Type: application/json" \

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
  "id": 2827698,
  "name": "8 New Copy Machines (sample)",
  "assignee_id": null,
  "close_date": "1/23/2017",
  "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. Create Opportunities for People and Companies to move them through one of your Pipelines.",
  "loss_reason_id": null,
  "pipeline_id": 213214,
  "pipeline_stage_id": 987790,
  "primary_contact_id": null,
  "priority": "None",
  "status": "Open",
  "tags": [],
  "interaction_count": 0,
  "monetary_value": 250000,
  "win_probability": 5,
  "date_created": 1483988829,
  "date_modified": 1489018922,
  "custom_fields": [
    {
      "custom_field_definition_id": 100764,
      "value": null
    },
    {
      "custom_field_definition_id": 103481,
      "value": null
    }
  ]
}