Connecting to Superchat

Superchat uses API Key authentication. The API key is passed via the X-API-KEY request header on every call.

Authentication

To authenticate to Superchat, you need to obtain your API key from the Superchat workspace settings.

Using API Key Authentication

You can obtain your API key from Settings > Integrations > API Key in your Superchat workspace.

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Superchat API key.

Example connection string:

Profile=C:\profiles\Superchat.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';

Available Tables

The Superchat API Profile provides access to messaging and contact data across 16 tables:

• Channels - Access channel definitions (WhatsApp, SMS, email, Instagram, Facebook, Telegram, live chat).
• ContactLists - Query contact list memberships; filter by ContactId to get lists for a specific contact.
• Contacts - Access contact records including handles, custom attributes, and gender.
• ConversationExports - Retrieve export details for a conversation; requires both ConversationId and Id.
• ConversationMessages - Retrieve messages for a specific conversation; requires ConversationId.
• ConversationNotes - Retrieve internal notes on conversations; requires ConversationId.
• Conversations - Query conversations across channels; filter by ContactId to scope to one contact.
• CurrentUser - Returns the authenticated user and workspace details for the active API key.
• CustomAttributes - Access custom attribute definitions for contacts and conversations.
• Files - Query uploaded files and their temporary signed download links.
• Inboxes - Access inbox configurations and the users assigned to each inbox.
• Labels - Retrieve label definitions used for tagging conversations.
• MessageAnalytics - Access delivery and engagement analytics for messages.
• TemplateFolders - Query template folder hierarchy for organizing message templates.
• Templates - Access message templates; filter by ChannelId or FolderId.
• Users - Access workspace users and their roles (admin, supervisor, member).

Usage Examples

Channels:

SELECT * FROM Channels

ContactLists:

SELECT * FROM ContactLists

Contacts:

SELECT * FROM Contacts

ConversationExports:

SELECT * FROM ConversationExports WHERE ConversationId = 'co_abc123' AND Id = 'ex_abc123'

ConversationMessages:

SELECT * FROM ConversationMessages WHERE ConversationId = 'co_abc123'

ConversationNotes:

SELECT * FROM ConversationNotes WHERE ConversationId = 'co_abc123'

Conversations:

SELECT * FROM Conversations

CurrentUser:

SELECT * FROM CurrentUser

CustomAttributes:

SELECT * FROM CustomAttributes

Files:

SELECT * FROM Files

Inboxes:

SELECT * FROM Inboxes

Labels:

SELECT * FROM Labels

MessageAnalytics:

SELECT * FROM MessageAnalytics

TemplateFolders:

SELECT * FROM TemplateFolders

Templates:

SELECT * FROM Templates

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	The API key used to authenticate requests to the Superchat API.
AuthScheme	The scheme used for authentication. Accepted entries are APIKey or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT