Connecting to Close
Close uses Token Authentication to control access to the API.
Using Token Authentication
The Close API key can be found under 'Settings' > 'Your API Keys' > 'New API Key'. You can set the API key as your Close API Key in ProfileSettings connection property.
Example connection string
Profile=C:\profiles\Close.apip;ProfileSettings='APIKey=my_api_key';
Usage Examples
Query activities by ID:
SELECT * FROM Activities
Query bulk action delete by ID:
SELECT * FROM BulkActionDelete WHERE Id = 'bulk_01234567890'
Query bulk action edit by ID:
SELECT * FROM BulkActionEdit WHERE Id = 'bulk_01234567890'
Query bulk action email records:
SELECT * FROM BulkActionEmail
Query bulk action subscription records:
SELECT * FROM BulkActionSubscription WHERE Id = 'bulk_01234567890'
Query call activities by ID:
SELECT * FROM CallActivities WHERE Id = 'act_01234567890'
Query comments by ID:
SELECT * FROM Comments WHERE Id = 'comm_01234567890'
Query comment threads:
SELECT * FROM CommentThreads WHERE Id = 'thread_01234567890'
Query connected accounts by ID:
SELECT * FROM ConnectedAccounts WHERE Id = 'conn_01234567890'
Query all contacts:
SELECT * FROM Contacts
Query created activities by ID:
SELECT * FROM CreatedActivities WHERE Id = 'act_01234567890'
Query custom activities:
SELECT * FROM CustomActivities WHERE Id = 'custom_01234567890'
Query custom activity instances by ID:
SELECT * FROM CustomActivityInstances WHERE Id = 'instance_01234567890'
Query custom fields for leads:
SELECT * FROM CustomFieldsLead WHERE Id = 'field_01234567890'
Query custom object instances:
SELECT * FROM CustomObjectInstances WHERE Id = 'instance_01234567890'
Query custom objects:
SELECT * FROM CustomObjects WHERE Id = 'object_01234567890'
Query dialers by ID:
SELECT * FROM Dialers WHERE Id = 'dialer_01234567890'
Query email activities by ID:
SELECT * FROM EmailActivities WHERE Id = 'email_01234567890'
Query email sequences:
SELECT * FROM EmailSequences WHERE Id = 'seq_01234567890'
Query email sequence schedule:
SELECT * FROM EmailSequenceSchedule
Query email templates:
SELECT * FROM EmailTemplates
Query email thread activities by ID:
SELECT * FROM EmailThreadActivities WHERE Id = 'thread_01234567890'
Query events by updated date:
SELECT * FROM Events WHERE DateUpdated >= '2024-01-01'
Query exports:
SELECT * FROM Exports
Query groups:
SELECT * FROM Groups
Query integration links:
SELECT * FROM IntegrationLink
Query lead merge activities:
SELECT * FROM LeadMergeActivities
Query leads by ID:
SELECT * FROM Leads WHERE Id = '01234567890'
Query lead status change activities by ID:
SELECT * FROM LeadStatusChangeActivities WHERE Id = 'status_01234567890'
Query lead statuses:
SELECT * FROM LeadStatuses
Query current user information:
SELECT * FROM Me
Query meeting activities:
SELECT * FROM MeetingActivities
Query note activities by created date:
SELECT * FROM NoteActivities WHERE DateCreated >= '2024-01-01'
Query opportunities by created date:
SELECT * FROM Opportunities WHERE DateCreated >= '2024-01-01'
Query opportunity statuses:
SELECT * FROM OpportunityStatus
Query opportunity status change activities by ID:
SELECT * FROM OpportunityStatusChangeActivities WHERE Id = 'oppstatus_01234567890'
Query organizations:
SELECT * FROM Organization WHERE Id = '12345'
Query phone numbers:
SELECT * FROM PhoneNumbers
Query pipelines:
SELECT * FROM Pipelines
Query rendered email template:
SELECT * FROM RenderEmailTemplate WHERE TemplateId = 'tmpl_01234567890' AND LeadId = 'lead_1234' AND ContactId = 'con_1234';
Query activity metrics report:
SELECT * FROM ReportActivityMetrics
Query activity organization report by date range:
SELECT * FROM ReportActivityOrganization WHERE OrganizationId = '12345' AND StartDate = '2024-01-01' AND EndDate = '2024-01-31'
Query sent emails report by date range:
SELECT * FROM ReportActivitySentEmails WHERE OrganizationId = '12345' AND StartDate = '2024-01-01' AND EndDate = '2024-01-31'
Query lead statuses report by date range:
SELECT * FROM ReportStatusesLead WHERE OrganizationId = '12345' AND StartDate = '2024-01-01' AND EndDate = '2024-01-31'
Query opportunity statuses report by date range:
SELECT * FROM ReportStatusesOpportunity WHERE OrganizationId = '12345' AND StartDate = '2024-01-01' AND EndDate = '2024-01-31'
Query roles:
SELECT * FROM Roles
Query scheduling links:
SELECT * FROM SchedulingLinks
Query send as permissions:
SELECT * FROM SendAs
Query sequences:
SELECT * FROM Sequences
Query sequence subscriptions:
SELECT * FROM SequenceSubscription WHERE SequenceId = 'sequ_12345'
Query smart views:
SELECT * FROM SmartViews
Query SMS activities by ID:
SELECT * FROM SMSActivity WHERE Id = 'sms_01234567890'
Query opportunity statuses:
SELECT * FROM StatusOpportunity
Query task completed activities by ID:
SELECT * FROM TaskCompletedActivities WHERE Id = 'task_01234567890'
Query tasks by created date:
SELECT * FROM Tasks WHERE DateCreated >= '2024-01-01'
Query user availability organization:
SELECT * FROM UserAvailabilityOrganization WHERE OrganizationId = 'org_1234'
Query users:
SELECT * FROM Users
Connection Properties
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.
| Property | Description |
| APIKey | Your Close API Key. |
| AuthScheme | The scheme used for authentication. Accepted entries are APIKey or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT |