API Data Provider - Online Help

Close Tables

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

Close Tables

Name Description
Activities Returns the list of activities
BulkActionDelete Fetch a single or list of bulk delete object.
BulkActionEdit List bulk edits
BulkActionEmail Gets the emails which has been sent in a bulk.
BulkActionSubscription Fetch a single or list of bulk sequence subscription object
CallActivities List or filter all Call activities
Comments Get the single or list of all the comments.
CommentThreads Get the single or list of all the comment threads.
ConnectedAccounts Get the single or list of all the connected accounts.
Contacts Get the Single or list of all the contacts
CreatedActivities List or filter all Created activities
CustomActivities Get the single or list of all the custom activity types.
CustomActivityInstances Get the single or list of all the custom activity instances.
CustomFieldsLead List single or all the custom fields for your organization.
CustomObjectInstances Get the single or list of all the custom object instances.
CustomObjects Get the single or list of all the custom object types.
Dialers Gets single dialer session by id or list of all dialer's sessions.
EmailActivities List or filter all Email activities
EmailSequenceSchedule Gets list of all emails sequence schedule.
EmailTemplates Gets single or list of all the email templates.
EmailThreadActivities List or filter all EmailThread activities.
Events Gets the single event by ID or list of all events.
Exports Get single export by ID or list of all exports.
Groups Get the single or list of all the groups.
IntegrationLink Get single or all integration links for your organization.
LeadMergeActivities List or filter all LeadMerge activities
Leads Get the single or list of all the leads.
LeadStatusChangeActivities List or filter all LeadStatusChange activities
LeadStatuses Returns the list of lead statuses.
Me Gets the complete details of Admin User
MeetingActivities List or filter all Meeting activities
NoteActivities List or filter single or all Note activities.
Opportunities Gets complete details of opportunities.
OpportunityStatus List opportunity statuses for your organization.
OpportunityStatusChangeActivities List or filter all OpportunityStatusChange activities
Organization Get an organization's details, including its current members (users), lead and opportunity statuses, etc.
PhoneNumbers Gets Single or List of Phone Numbers.
Pipelines Get the single or list of all the pipelines.
RenderEmailTemplate Render an email template for the given lead/contact using the current user context.
ReportActivityMetrics List the predefined metrics used in activity reports.
ReportActivityOrganization Get an activity report for an organization.
ReportActivitySentEmails Get a report about sent emails grouped by template.
ReportStatusesLead Get a lead status change report.
ReportStatusesOpportunity Get an opportunity status change report.
Roles Gets Sinlge role or list of roles.
SchedulingLinks Get the single or list of all the scheduling links.
SendAs Get the single or list of all the send as permissions.
Sequences Get the single or list of all sequences for email and call automation.
SequenceSubscription Gets list of Sequence Subscriptons
SmartViews Get the single or list of all the smart views (saved searches).
SMSActivity Returns single or list of SMS activities.
TaskCompletedActivities List or filter all TaskCompleted activities
Tasks Tasks are action items with a given date that are assigned to a sales rep.
UserAvailabilityOrganization Fetch the availability statuses of all users within an organization.
Users Get the list of single and all the users.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 25.0.9539.0