API Data Provider - Online Help

Copper Tables

The provider models the data in API into a list of tables that can be queried using standard SQL statements.

Generally, querying API tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. These types of situations are clearly documented at the top of the table page linked below.

Copper Tables

Name Description
Account Fetch Account Details
Activities Fetch an Activity by ID
ActivityTypes List Activity Types
Companies Fetch a Company by ID
CompanyActivities See a Company's Activities
ConnectFields List the connections on specified entity
ContactTypes List Contact Types
CustomActivityTypes List All Custom Activity Types
CustomerSources List Customer Sources
CustomFields List Custom Field Definitions
LeadActivities See a Lead's Activities
Leads Fetch a Lead by ID
LeadStatuses List Lead Statuses
LossReasons List Loss Reasons
Opportunities Fetch an Opportunity by ID
People Fetch a Person by ID
PeopleActivities See a Person's Activities
Pipelines List Pipelines
PipelineStages List Pipeline Stages
Projects Fetch a Project by ID
RelatedItems View all records related to an Entity
Tasks Fetch a Task by ID
Users Fetch User by ID
Webhooks List all subscriptions

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8487.0