Connecting to Respondio

Using API Key Authentication

Respond.io uses API key authentication. To obtain an API key:

Log in to your Respond.io account.
Navigate to Settings in your workspace.
Select Developer under the Integrations section.
Copy the API key displayed on the page.

After obtaining your API key, set the following connection properties:

AuthScheme: Set this to APIKey.

Set the following in the ProfileSettings connection property:

APIKey: Set this to your Respond.io API key.

Example Connection String

Profile=C:\profiles\Respondio.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";

Connecting to Respond.io

Once the authentication is configured, you can connect to Respond.io and query data from any of the available tables such as Contacts, SpaceChannels, SpaceUsers, and more.

Available Tables

The Respond.io API Profile provides access to the following tables:

Contacts: Retrieve contacts in the Respond.io workspace
ContactChannels: Retrieve messaging channels associated with a specific contact (requires ContactIdentifier)
ContactMessages: Retrieve messages exchanged with a specific contact (requires ContactIdentifier)
SpaceUsers: Retrieve users belonging to the Respond.io workspace
SpaceCustomFields: Retrieve custom contact field definitions configured in the workspace
SpaceChannels: Retrieve messaging channels connected to the workspace
SpaceChannelTemplates: Retrieve message templates available for a specific messaging channel (requires ChannelId)
SpaceClosingNotes: Retrieve closing note categories defined in the workspace

Important Notes

The Respond.io API uses cursor-based pagination. The driver automatically follows the pagination.next URL returned in each response to retrieve all pages of results.
Several child tables require a parent identifier to be specified as a filter: ContactChannels and ContactMessages require ContactIdentifier, and SpaceChannelTemplates requires ChannelId.
ContactIdentifier accepts three formats: id:{contactId} (e.g. id:438180634), email:{email} (e.g. email:[email protected]), or phone:{E.164} (e.g. phone:+14155550001).
Date and timestamp fields use Unix epoch format. Set PreferredDateFormats='UNIX;UNIXMILIS;yyyy-MM-dd' in the connection string for proper date handling.
Rate limiting applies - the Respond.io API allows up to 20 requests per minute. Refer to the Respond.io API documentation for current limits.

API Documentation

For more information about the Respond.io API, see the official Respond.io API documentation.

Usage Examples

Contacts (list all):

SELECT * FROM Contacts

Contacts (single by identifier):

SELECT * FROM Contacts WHERE Identifier = 'id:438180634'

ContactChannels:

SELECT * FROM ContactChannels WHERE ContactIdentifier = 'id:438180634'

ContactMessages:

SELECT * FROM ContactMessages WHERE ContactIdentifier = 'id:438180634'

SpaceUsers:

SELECT * FROM SpaceUsers

SpaceCustomFields:

SELECT * FROM SpaceCustomFields

SpaceChannels:

SELECT * FROM SpaceChannels

SpaceChannelTemplates:

SELECT * FROM SpaceChannelTemplates WHERE ChannelId = 12345

SpaceClosingNotes:

SELECT * FROM SpaceClosingNotes

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 Respond.io API.
AuthScheme	The scheme used for authentication. Accepted entries are APIKey or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT, OAUTH_PASSWORD