> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/copper.md).

# Copper

Create, search, and read Copper CRM people, companies, and opportunities, create leads and tasks, and log activities.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector        | Authentication |
| ---------------- | -------------- |
| Copper (API Key) | API Key        |

#### Copper (API Key)

Connect to Copper CRM with an API key and the email of the user who generated it.

**Set up in Copper**

1. Prepare the Copper account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Key:** Your Copper API key. Generate one in Copper under Settings > Integrations > API Keys > Generate API Key.
3. **User Email:** The email of the Copper user who generated the API key. Copper records every change made through this connection as that user.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Copper (API Key)**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                                                                                    |
| ------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| API Key       | Yes      | Your Copper API key. Generate one in Copper under Settings > Integrations > API Keys > Generate API Key. [Provider instructions](https://developer.copper.com/introduction/authentication.html). |
| User Email    | Yes      | The email of the Copper user who generated the API key. Copper records every change made through this connection as that user.                                                                   |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Copper** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Create Person

Create a person (contact) in Copper.

**Inputs**

| Field        | Type             | Required | Description                                                                                                   |
| ------------ | ---------------- | -------- | ------------------------------------------------------------------------------------------------------------- |
| Name         | string           | Yes      | Name of the record to create.                                                                                 |
| Email        | string           | No       | Work email address.                                                                                           |
| Phone        | string           | No       | Work phone number.                                                                                            |
| Job Title    | string           | No       | Job title.                                                                                                    |
| Company      | select (integer) | No       | Copper company to link the record to. Options load from the selected connection.                              |
| Company Name | string           | No       | Company name, when the company is not a Copper record yet.                                                    |
| Contact Type | select (integer) | No       | Contact type, such as Potential Customer or Current Customer. Options load from the selected connection.      |
| Owner        | select (integer) | No       | Copper user who owns the record. Leave blank for Copper's default. Options load from the selected connection. |
| Details      | textarea         | No       | Free-form notes stored on the record.                                                                         |

**Outputs**

| Field     | Type    | Description                |
| --------- | ------- | -------------------------- |
| Person    | object  | The created Copper person. |
| Person ID | integer | ID of the created person.  |

#### Create Company

Create a company in Copper.

**Inputs**

| Field        | Type             | Required | Description                                                                                                   |
| ------------ | ---------------- | -------- | ------------------------------------------------------------------------------------------------------------- |
| Name         | string           | Yes      | Name of the record to create.                                                                                 |
| Email Domain | string           | No       | Email domain of the company, without the @.                                                                   |
| Phone        | string           | No       | Work phone number.                                                                                            |
| Contact Type | select (integer) | No       | Contact type, such as Potential Customer or Current Customer. Options load from the selected connection.      |
| Owner        | select (integer) | No       | Copper user who owns the record. Leave blank for Copper's default. Options load from the selected connection. |
| Details      | textarea         | No       | Free-form notes stored on the record.                                                                         |

**Outputs**

| Field      | Type    | Description                 |
| ---------- | ------- | --------------------------- |
| Company    | object  | The created Copper company. |
| Company ID | integer | ID of the created company.  |

#### Create Lead

Create a lead in Copper.

**Inputs**

| Field        | Type             | Required | Description                                                                                                   |
| ------------ | ---------------- | -------- | ------------------------------------------------------------------------------------------------------------- |
| Name         | string           | Yes      | Name of the record to create.                                                                                 |
| Email        | string           | No       | Work email address.                                                                                           |
| Phone        | string           | No       | Work phone number.                                                                                            |
| Job Title    | string           | No       | Job title.                                                                                                    |
| Company Name | string           | No       | Company the lead works for.                                                                                   |
| Source       | select (integer) | No       | Where the customer came from, such as Email or Cold Call. Options load from the selected connection.          |
| Value        | number           | No       | Expected deal value, in the account currency. Minimum: 0.                                                     |
| Owner        | select (integer) | No       | Copper user who owns the record. Leave blank for Copper's default. Options load from the selected connection. |
| Details      | textarea         | No       | Free-form notes stored on the record.                                                                         |

**Outputs**

| Field   | Type    | Description              |
| ------- | ------- | ------------------------ |
| Lead    | object  | The created Copper lead. |
| Lead ID | integer | ID of the created lead.  |

#### Create Opportunity

Create an opportunity (deal) in Copper.

**Inputs**

| Field           | Type             | Required | Description                                                                                                   |
| --------------- | ---------------- | -------- | ------------------------------------------------------------------------------------------------------------- |
| Name            | string           | Yes      | Name of the record to create.                                                                                 |
| Primary Contact | select (integer) | No       | Copper person who is the main contact for this deal. Options load from the selected connection.               |
| Company         | select (integer) | No       | Copper company to link the record to. Options load from the selected connection.                              |
| Pipeline        | select (integer) | No       | Pipeline for the deal. Leave blank for the account default. Options load from the selected connection.        |
| Stage           | select (integer) | No       | Stage in the selected pipeline. Leave blank for its first stage. Options load from the selected connection.   |
| Source          | select (integer) | No       | Where the customer came from, such as Email or Cold Call. Options load from the selected connection.          |
| Value           | number           | No       | Deal value, in the account currency. Minimum: 0.                                                              |
| Owner           | select (integer) | No       | Copper user who owns the record. Leave blank for Copper's default. Options load from the selected connection. |
| Details         | textarea         | No       | Free-form notes stored on the record.                                                                         |

**Outputs**

| Field          | Type    | Description                     |
| -------------- | ------- | ------------------------------- |
| Opportunity    | object  | The created Copper opportunity. |
| Opportunity ID | integer | ID of the created opportunity.  |

#### Create Task

Create a task in Copper, optionally linked to a record.

**Inputs**

| Field               | Type             | Required | Description                                                                                                   |
| ------------------- | ---------------- | -------- | ------------------------------------------------------------------------------------------------------------- |
| Name                | string           | Yes      | Name of the record to create.                                                                                 |
| Details             | textarea         | No       | Free-form notes stored on the record.                                                                         |
| Owner               | select (integer) | No       | Copper user who owns the record. Leave blank for Copper's default. Options load from the selected connection. |
| Due Date            | datetime         | No       | When the task is due.                                                                                         |
| Priority            | select (string)  | No       | Task priority: None, Low, Medium, or High. Available values: None, Low, Medium, High.                         |
| Related Record Type | select (string)  | No       | Type of record to link the task to. Available values: Person, Company, Lead, Opportunity, Project.            |
| Related Record      | select (integer) | No       | Record to link the task to. Select the record type first. Options load from the selected connection.          |

**Outputs**

| Field   | Type    | Description              |
| ------- | ------- | ------------------------ |
| Task    | object  | The created Copper task. |
| Task ID | integer | ID of the created task.  |

#### Log Activity

Log a note, call, or other activity on a Copper record.

**Inputs**

| Field         | Type             | Required | Description                                                                                                            |
| ------------- | ---------------- | -------- | ---------------------------------------------------------------------------------------------------------------------- |
| Record Type   | select (string)  | Yes      | Type of record to log the activity on. Available values: Person, Company, Lead, Opportunity, Project.                  |
| Record        | select (integer) | Yes      | Record to log the activity on. Options load from the selected connection.                                              |
| Details       | textarea         | Yes      | What happened, such as the note text or call summary.                                                                  |
| Activity Type | select (integer) | No       | Kind of activity, such as Note or Phone Call. Defaults to Note. Options load from the selected connection. Default: 0. |
| Activity Date | datetime         | No       | When the activity happened. Defaults to now.                                                                           |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Activity    | object  | The created Copper activity. |
| Activity ID | integer | ID of the created activity.  |

#### Search People

Search Copper people (contacts) by name, email, company, or owner.

**Inputs**

| Field            | Type             | Required | Description                                                                            |
| ---------------- | ---------------- | -------- | -------------------------------------------------------------------------------------- |
| Results per Page | integer          | No       | Number of records per page, 1 to 200. Minimum: 1. Maximum: 200. Default: 20.           |
| Page             | integer          | No       | Page to return, starting at 1. Minimum: 1. Default: 1.                                 |
| Name             | string           | No       | Full name to match. Leave blank to list all records.                                   |
| Email            | string           | No       | Return only people with this email address.                                            |
| Company          | select (integer) | No       | Return only records linked to this company. Options load from the selected connection. |
| Owner            | select (integer) | No       | Return only records owned by this user. Options load from the selected connection.     |

**Outputs**

| Field      | Type          | Description                                   |
| ---------- | ------------- | --------------------------------------------- |
| People     | object\_array | Matching Copper people.                       |
| Person IDs | number\_array | IDs of the matching people.                   |
| Has More   | boolean       | True when another page of results can follow. |

#### Search Companies

Search Copper companies by name, email domain, or owner.

**Inputs**

| Field            | Type             | Required | Description                                                                        |
| ---------------- | ---------------- | -------- | ---------------------------------------------------------------------------------- |
| Results per Page | integer          | No       | Number of records per page, 1 to 200. Minimum: 1. Maximum: 200. Default: 20.       |
| Page             | integer          | No       | Page to return, starting at 1. Minimum: 1. Default: 1.                             |
| Name             | string           | No       | Full name to match. Leave blank to list all records.                               |
| Email Domain     | string           | No       | Return only companies with this email domain.                                      |
| Owner            | select (integer) | No       | Return only records owned by this user. Options load from the selected connection. |

**Outputs**

| Field       | Type          | Description                                   |
| ----------- | ------------- | --------------------------------------------- |
| Companies   | object\_array | Matching Copper companies.                    |
| Company IDs | number\_array | IDs of the matching companies.                |
| Has More    | boolean       | True when another page of results can follow. |

#### Search Opportunities

Search Copper opportunities by name, status, pipeline, contact, company, or owner.

**Inputs**

| Field            | Type             | Required | Description                                                                                     |
| ---------------- | ---------------- | -------- | ----------------------------------------------------------------------------------------------- |
| Results per Page | integer          | No       | Number of records per page, 1 to 200. Minimum: 1. Maximum: 200. Default: 20.                    |
| Page             | integer          | No       | Page to return, starting at 1. Minimum: 1. Default: 1.                                          |
| Name             | string           | No       | Full name to match. Leave blank to list all records.                                            |
| Status           | select (string)  | No       | Return only opportunities with this status. Available values: Open, Won, Lost, Abandoned.       |
| Pipeline         | select (integer) | No       | Return only opportunities in this pipeline. Options load from the selected connection.          |
| Primary Contact  | select (integer) | No       | Return only opportunities with this primary contact. Options load from the selected connection. |
| Company          | select (integer) | No       | Return only records linked to this company. Options load from the selected connection.          |
| Owner            | select (integer) | No       | Return only records owned by this user. Options load from the selected connection.              |

**Outputs**

| Field           | Type          | Description                                   |
| --------------- | ------------- | --------------------------------------------- |
| Opportunities   | object\_array | Matching Copper opportunities.                |
| Opportunity IDs | number\_array | IDs of the matching opportunities.            |
| Has More        | boolean       | True when another page of results can follow. |

#### Get Person

Get a Copper person (contact) by ID.

**Inputs**

| Field  | Type             | Required | Description                                                 |
| ------ | ---------------- | -------- | ----------------------------------------------------------- |
| Person | select (integer) | Yes      | Person to fetch. Options load from the selected connection. |

**Outputs**

| Field  | Type   | Description        |
| ------ | ------ | ------------------ |
| Person | object | The Copper person. |

#### Get Company

Get a Copper company by ID.

**Inputs**

| Field   | Type             | Required | Description                                                  |
| ------- | ---------------- | -------- | ------------------------------------------------------------ |
| Company | select (integer) | Yes      | Company to fetch. Options load from the selected connection. |

**Outputs**

| Field   | Type   | Description         |
| ------- | ------ | ------------------- |
| Company | object | The Copper company. |

#### Get Opportunity

Get a Copper opportunity (deal) by ID.

**Inputs**

| Field       | Type             | Required | Description                                                      |
| ----------- | ---------------- | -------- | ---------------------------------------------------------------- |
| Opportunity | select (integer) | Yes      | Opportunity to fetch. Options load from the selected connection. |

**Outputs**

| Field       | Type   | Description             |
| ----------- | ------ | ----------------------- |
| Opportunity | object | The Copper opportunity. |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/copper.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
