# Copper — CRM API: overview

> Canonical URL: https://developers.apideck.com/apis/crm/copper/overview

When you need CRM software that works with G Suite, you need Copper. Give us a try and see how we can help your business build stronger customer relationships.
- Status: live
- Authentication: apiKey

- **apideck credentials note:** Each consumer generates their own Copper API key.
- **partnership required:** false
- **external guides:**   - **url:** https://support.copper.com/en/articles/8823347-generating-an-api-key
  - **title:** Generating an API key
  - **source:** Copper
  - **url:** https://developer.copper.com/introduction/authentication.html
  - **title:** Copper Developer API: authentication
  - **source:** Copper
  - **title:** Copper Developer API: requests and rate limits
  - **url:** https://developer.copper.com/introduction/requests.html
  - **source:** Copper
- **account type required:** Copper account. The API sees only the records the key owner's Team Permissions allow.
- **sandbox url:** https://www.copper.com/signup
- **webhooks:** No webhooks - read the resources to detect changes.
- **apideck credentials available:** false
- **sandbox note:** Free 14-day trial on the Business plan, no credit card; sign-up needs a Google or Gmail account.
- **beta:** false
- **supported resource categories:**   - **resources:** companies
contacts
opportunities
  - **name:** CRM
  - **name:** Lead
  - **resources:** leads
- **rate limits:** 180 requests a minute; bulk APIs also allow 3 requests a second.
- **responsibility matrix:**   - **area:** Enable the Copper Connector
  - **customer:** ✓ Via Apideck Dashboard
  - **consumer:** ✓
  - **area:** Generate the API Key in Copper
  - **area:** Supply the API Key & Email in Vault
  - **consumer:** ✓
  - **consumer:** ✓
  - **area:** Choose the Default Status for New Opportunities
  - **apideck:** ✓
  - **area:** Store & Encrypt Credentials
  - **apideck:** ✓ Maintains connector
  - **customer:** ✓ Builds the requests
  - **area:** Build via the Unified API
  - **apideck:** ✓ Logs & alerts
  - **area:** Monitor Connections
  - **customer:** ✓ Via Apideck Dashboard
  - **consumer:** ✓ Can delete the key anytime
- **difficulty reason:** API Key Authentication - Each Consumer Generates Their Own Key in Copper
- **consumer access level:** A Copper Admin, since only Admin users can generate API keys.
- **important to know:** Copper requires the API key together with the email address of the user who generated it, so the consumer supplies both when connecting.
- **environment notes:**   - **environment:** Single environment
  - **description:** Copper runs one production host, https://api.copper.com/developer_api/v1, and no separate test host. Testing and production use the same kind of credential, and anything the integration writes lands in a live Copper account.
- **sandbox available:** true
- **authentication note:** Sent in request headers.
- **difficulty:** moderate

## Supported resources

- **custom field support:** true
- **name:** Leads
- **id:** leads
- **downstream name:** Leads
- **downstream id:** leads
- **status:** live
- **custom field support:** true
- **downstream name:** People
- **name:** Contacts
- **id:** contacts
- **downstream id:** people
- **status:** live
- **name:** Companies
- **downstream name:** Companies
- **custom field support:** true
- **status:** live
- **downstream id:** companies
- **id:** companies
- **status:** live
- **custom field support:** true
- **id:** opportunities
- **downstream name:** Opportunities
- **name:** Opportunities
- **downstream id:** opportunities

An omitted operation list does not establish operation support. Verify the selected operation in the coverage matrix.

[API reference](https://developers.apideck.com/apis/crm/reference.md) · [Coverage matrix](https://developers.apideck.com/apis/crm/coverage)