> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Copper

> How to set up the Copper connector, plus the actions and events that are available.

![Copper](https://stackone-logos.com/api/copper/filled/svg)

v2.2.0[See changelog](https://docs.stackone.com/connectors/copper/changelog.md)

[58 actions](#actions) · [21 events](#events) · 2 auth methods

CRM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/copper/guides/connector-profile/api-key.md)
>
> Connects with an API key and the email of the Copper Admin user who generated it, so the connection uses that user's acc...

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/copper/guides/connector-profile/oauth-2-0.md)
>
> Requires an OAuth app registered with Copper. Each user authorizes their own Copper account, and access tokens do not ex...

Optionally, configure receiving Events for Copper into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/copper/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/copper/guides/link-account/api-key.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/copper/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

leads

No scopes found

58 actions

ActionDescriptionRequired scopes

Fetch Account Details`copper_fetch_account_details`

Retrieve details of the authenticated Copper account

Fetch User By ID`copper_fetch_user_by_id`

Retrieve a single Copper user by user ID

Fetch API User`copper_fetch_api_user`

Retrieve details of the user associated with the API credentials

List Users`copper_list_users`

List users in the Copper account

List Leads`copper_list_leads`

Search and list leads in Copper

`leads`

Fetch Lead By ID`copper_fetch_lead_by_id`

Retrieve a specific lead by ID

`leads`

Create Lead`copper_create_lead`

Create a new lead in Copper

`leads`

Update Lead`copper_update_lead`

Update an existing lead

`leads`

Delete Lead`copper_delete_lead`

Delete a lead from Copper

`leads`

Upsert Lead`copper_upsert_lead`

Create or update a lead by matching on name or email. If a lead matches the supplied criteria it is updated with the sup...

`leads`

Convert Lead`copper_convert_lead`

Convert a lead into a person, company, and optional opportunity

`leads`

List Lead Activities`copper_list_lead_activities`

List activities logged against a specific lead

`leads`

List Lead Statuses`copper_list_lead_statuses`

List all configured lead statuses in Copper

`leads`

List People`copper_list_people`

Search and list people (contacts) in Copper

Fetch Person By ID`copper_fetch_person_by_id`

Retrieve a specific person by their unique ID

Fetch Person By Email`copper_fetch_person_by_email`

Retrieve a person by their email address

Create Person`copper_create_person`

Create a new person (contact) in Copper

Update Person`copper_update_person`

Update an existing person in Copper

Delete Person`copper_delete_person`

Delete a person from Copper

List Person Activities`copper_list_person_activities`

List activities related to a specific person

List Contact Types`copper_list_contact_types`

List all contact types available in the Copper account

List Companies`copper_list_companies`

List companies in Copper using the search endpoint

Fetch Company By ID`copper_fetch_company_by_id`

Retrieve a specific company by ID

Create Company`copper_create_company`

Create a new company in Copper

Update Company`copper_update_company`

Update an existing company in Copper

Delete Company`copper_delete_company`

Permanently delete a company from Copper

List Company Activities`copper_list_company_activities`

List activities for a specific company

List Opportunities`copper_list_opportunities`

Search and list opportunities in Copper

Fetch Opportunity By ID`copper_fetch_opportunity_by_id`

Retrieve a specific opportunity by ID

Create Opportunity`copper_create_opportunity`

Create a new opportunity in Copper

Update Opportunity`copper_update_opportunity`

Update an existing opportunity

Delete Opportunity`copper_delete_opportunity`

Delete an opportunity from Copper

List Pipelines`copper_list_pipelines`

List all pipelines in Copper

List Pipeline Stages`copper_list_pipeline_stages`

List all pipeline stages in Copper

List Loss Reasons`copper_list_loss_reasons`

List all loss reasons in Copper

List Customer Sources`copper_list_customer_sources`

List all customer sources in Copper

List Projects`copper_list_projects`

Search and list projects in Copper

Fetch Project By ID`copper_fetch_project_by_id`

Retrieve a specific project by ID

Create Project`copper_create_project`

Create a new project in Copper

Update Project`copper_update_project`

Update an existing project

Delete Project`copper_delete_project`

Delete a project from Copper

List Tasks`copper_list_tasks`

Search and list tasks in Copper

Fetch Task By ID`copper_fetch_task_by_id`

Retrieve a specific task by ID

Create Task`copper_create_task`

Create a new task in Copper

Update Task`copper_update_task`

Update an existing task

Delete Task`copper_delete_task`

Delete a task from Copper

List Activities`copper_list_activities`

Search and list activities in Copper CRM

Fetch Activity By ID`copper_fetch_activity_by_id`

Retrieve a specific activity by ID

Create Activity`copper_create_activity`

Create a new activity in Copper CRM

Update Activity`copper_update_activity`

Update an existing activity

Delete Activity`copper_delete_activity`

Delete an activity from Copper CRM

List Activity Types`copper_list_activity_types`

List all activity types in Copper CRM

List Tags`copper_list_tags`

Retrieve all tags in Copper CRM

List Custom Field Definitions`copper_list_custom_field_definitions`

Retrieve all custom field definitions in Copper CRM

Fetch Custom Field Definition`copper_fetch_custom_field_definition`

Retrieve a specific custom field definition by ID

View All Related Records`copper_view_all_related_records`

View all records related to an entity in Copper

Relate Record To Entity`copper_relate_record_to_entity`

Relate an existing record to an entity in Copper — the ONLY tool for cross-record links between two of the six types (le...

Remove Relationship`copper_remove_relationship_record`

Remove a relationship between a record and an entity in Copper

## Events

Tags

Select all
|
Clear

Activities

Companies

Leads

Opportunities

People

Projects

Tasks

Webhooks

No tags found

21 events

EventDescriptionTags

Lead Created Webhook`copper_webhook_lead_new`

Processes Copper lead.new events.

LeadsWebhooks

Lead Updated Webhook`copper_webhook_lead_update`

Processes Copper lead.update events.

LeadsWebhooks

Lead Deleted Webhook`copper_webhook_lead_delete`

Processes Copper lead.delete events.

LeadsWebhooks

Person Created Webhook`copper_webhook_person_new`

Processes Copper person.new events.

PeopleWebhooks

Person Updated Webhook`copper_webhook_person_update`

Processes Copper person.update events.

PeopleWebhooks

Person Deleted Webhook`copper_webhook_person_delete`

Processes Copper person.delete events.

PeopleWebhooks

Company Created Webhook`copper_webhook_company_new`

Processes Copper company.new events.

CompaniesWebhooks

Company Updated Webhook`copper_webhook_company_update`

Processes Copper company.update events.

CompaniesWebhooks

Company Deleted Webhook`copper_webhook_company_delete`

Processes Copper company.delete events.

CompaniesWebhooks

Opportunity Created Webhook`copper_webhook_opportunity_new`

Processes Copper opportunity.new events.

OpportunitiesWebhooks

Opportunity Updated Webhook`copper_webhook_opportunity_update`

Processes Copper opportunity.update events.

OpportunitiesWebhooks

Opportunity Deleted Webhook`copper_webhook_opportunity_delete`

Processes Copper opportunity.delete events.

OpportunitiesWebhooks

Project Created Webhook`copper_webhook_project_new`

Processes Copper project.new events.

ProjectsWebhooks

Project Updated Webhook`copper_webhook_project_update`

Processes Copper project.update events.

ProjectsWebhooks

Project Deleted Webhook`copper_webhook_project_delete`

Processes Copper project.delete events.

ProjectsWebhooks

Task Created Webhook`copper_webhook_task_new`

Processes Copper task.new events.

TasksWebhooks

Task Updated Webhook`copper_webhook_task_update`

Processes Copper task.update events.

TasksWebhooks

Task Deleted Webhook`copper_webhook_task_delete`

Processes Copper task.delete events.

TasksWebhooks

Activity Created Webhook`copper_webhook_activity_log_new`

Processes Copper activity\_log.new events.

ActivitiesWebhooks

Activity Updated Webhook`copper_webhook_activity_log_update`

Processes Copper activity\_log.update events.

ActivitiesWebhooks

Activity Deleted Webhook`copper_webhook_activity_log_delete`

Processes Copper activity\_log.delete events.

ActivitiesWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.