API Data Provider - Online Help

CapsuleCrm 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.

CapsuleCrm Tables

Name Description
ActivityTypes Returns the collection of all the activity types on this Capsule account.
CaseEntries List notes, emails and completed tasks for cases.
CaseParties Returns the collection of additional parties related to a given case.
Cases Returns the collection of Cases on the Capsule account.
CaseTags Returns the collection of all of the case tags on this Capsule account
Categories Returns collection of all the lost reasons on this Capsule account.
Countries List the country codes that Capsule supports.
Currencies List the currency codes that Capsule supports.
CurrentUser Shows the details of the user the provided access token is associated with.
DeletedCases Returns a collection of cases that have been deleted from Capsule since the date specified in the since parameter. Also contains cases that have been made restricted for the user calling the API endpoint.
DeletedOpportunities Returns a collection of opportunities that have been deleted from Capsule since the date specified in the since parameter. Also contains opportunities that have been made restricted for the user calling the API endpoint.
DeletedParties Returns a collection of parties that have been deleted from Capsule since the date specified in the since parameter. Also contains parties that have been made restricted for the user calling the API endpoint.
Employees Returns the collection of employees linked to this organisation.
Entries List notes, emails and the details of completed party tasks in descending order starting with the most recent entry date first.
LostReasons Returns collection of all the lost reasons on this Capsule account.
Milestones Returns the collection of all the milestones on the Capsule account.
Opportunities Returns the collection of Opportunities on the Capsule account.
OpportunityCases Returns the collection of cases related to a given opportunity.
OpportunityEntries List notes, emails and completed tasks for opportunities.
OpportunityParties Returns the collection of additional parties related to a given opportunity.
OpportunityTags Returns the collection of all of the opportunity tags on this Capsule account
Parties Returns the collection of Parties on the Capsule account.
PartyCases Returns the collection of cases related to a given party.
PartyEntries List notes, emails and completed tasks for parties.
PartyOpportunities Returns the collection of all opportunities associated with the given party.
PartyTags Returns the collection of all of the party tags on this Capsule account
SearchCases Search for cases on the Capsule account. This will return the same results as the global search inside Capsule.
SearchOpportunities Search for opportunities on the Capsule account. This will return the same results as the global search inside Capsule.
SearchParties Search for parties on the Capsule account. This will return the same results as the global search inside Capsule.
Tasks Returns the collection of Tasks on the Capsule account.
Teams Returns all the teams on the Capsule account.
Users Returns all the users on the Capsule account.

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