COcopper
Opportunities

Search opportunities

Search opportunities. Response uses a pagination envelope (page_number,total,data) so ChatGPT can read pagination info; the X-PW-TOTAL header still exists. Paginate with page_number/page_size (max 200) until received records equal total. Limited to 100K results.

post/opportunities/search

Request

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

Query parameters

custom_field_computed_valuesboolean

When true, returns computed custom field values (human-readable labels) in addition to option IDs. WARNING: This significantly increases payload size. For ChatGPT/Copper GPT, only set this to true when the user explicitly asks for custom field labels, and then reduce page_size (<= 10) and fields to ONLY what is absolutely required.

Request body

idsinteger[]

An array of Opportunity IDs to retrieve

company_namestring

Filter by the name of the primary company associated with the opportunity

company_idsinteger[]

An array of company IDs to filter by (the companies these opportunities are associated with). Use -2 for no company.

primary_contact_idsinteger[]

An array of person IDs who are the primary contacts for these opportunities

close_dateinteger

Filter by expected close date (Unix timestamp)

minimum_close_dateinteger

Filter by minimum close date (Unix timestamp)

maximum_close_dateinteger

Filter by maximum close date (Unix timestamp)

minimum_monetary_valuenumber

Filter by minimum monetary value

maximum_monetary_valuenumber

Filter by maximum monetary value

minimum_win_probabilityinteger

Filter by minimum win probability (0-100)

maximum_win_probabilityinteger

Filter by maximum win probability (0-100)

tagsstring[]

An array of tags to filter by

assignee_idsinteger[]

An array of assignee IDs to filter by (the user IDs who own these opportunities). Use -2 for no assignee.

pipeline_idsinteger[]

An array of pipeline IDs to filter by

pipeline_stage_idsinteger[]

An array of pipeline stage IDs to filter by

statusesstring[]

An array of statuses to filter by

prioritiesstring[]

An array of priorities to filter by

loss_reason_idsinteger[]

An array of loss reason IDs to filter by (for Lost opportunities)

customer_source_idsinteger[]

An array of customer source IDs to filter by

followed1 | 2

Filter by followed status. Use 1 for followed opportunities, 2 for not followed.

ageinteger

Maximum age in seconds of the opportunity record

minimum_interaction_countinteger

Filter by minimum number of interactions

maximum_interaction_countinteger

Filter by maximum number of interactions

minimum_interaction_dateinteger

Unix timestamp for the earliest date of the last interaction

maximum_interaction_dateinteger

Unix timestamp for the latest date of the last interaction

minimum_date_stage_changedinteger

Unix timestamp for the minimum date when the pipeline stage was changed

maximum_date_stage_changedinteger

Unix timestamp for the maximum date when the pipeline stage was changed

minimum_created_dateinteger

Unix timestamp for the minimum creation date

maximum_created_dateinteger

Unix timestamp for the maximum creation date

minimum_modified_dateinteger

Unix timestamp for the minimum modification date

maximum_modified_dateinteger

Unix timestamp for the maximum modification date

sort_by'assignee' | 'company_name' | 'customer_source_id' | 'date_created' | 'date_modified' | 'inactive_days' | 'interaction_count' | 'last_interaction' | 'monetary_unit' | 'monetary_value' | 'name' | 'primary_contact' | 'priority' | 'stage' | 'status'

The field on which to sort the results. Possible values: assignee, company_name, customer_source_id, date_created, date_modified, inactive_days, interaction_count, last_interaction, monetary_unit, monetary_value, name, primary_contact, priority, stage, status

sort_direction'asc' | 'desc'

The direction in which to sort the results

page_numberinteger

The page number (starting with 1) that you would like to view

page_sizeinteger

The number of entries included in a page of results

Example request

{
  "name": {
    "value": "Q4",
    "special_value": [
      {
        "type": "partial"
      }
    ]
  },
  "fields": [
    "id",
    "name",
    "company_id",
    "pipeline_stage_id",
    "monetary_value",
    "close_date",
    "assignee_id"
  ]
}

Response

Opportunities retrieved successfully

page_numberinteger required

Current page number (defaults to 1 when not provided in the request).

totalinteger required

Total number of records that match the request filters (equivalent to the X-PW-TOTAL header).

Example response

{
  "page_number": 1,
  "total": 775,
  "data": []
}

Changes

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