API Data Provider - Online Help

Connecting to Keap

To authenticate to Keap, and connect to your own data or to allow other users to connect to their data, you can use the OAuth standard.

Using OAuth Authentication

First, you will need to register an OAuth application with Keap. To do so, login to your Keap Developer Account, then go to Apps from dropdown menu at up right corner and create a new application. Your Oauth application will be assigned API Keys (key and secret).

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

  • AuthScheme: Set this to OAuth.
  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
  • OAuthClientId: Set this to the Key that is specified in your app API Keys.
  • OAuthClientSecret: Set this to the Secret that is specified in your app API Keys.

Using API Key Authentication

An API Key can be either a Personal Access Token or a Service Account Key. To create either of these, you will need to login to your Keap web application. From the main page, click on the user bubble in the bottom left, then "Settings." In the "Settings" dialog, click "API" at the bottom of the list. On this page, select either of the "Personal Access Tokens" or "Service Account Keys" headings at the top, then click "New Token" to create your API Key.

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

  • AuthScheme: Set this to APIKey.
  • APIKey: Set this to your Personal Access Token or Service Account Key.

Example connection string:

Profile=C:\profiles\Keap.apip;Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;

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 Keap API token. Can be either a Personal Access Token or Service Account Key.
AuthScheme The scheme used for authentication. Accepted entries are None or OAuth.
Allowed values are: BASIC, NONE, NTLM, OAUTH, OAUTH_CLIENT, APIKEY
InitiateOAuth Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.
Allowed values are: OFF, GETANDREFRESH, REFRESH
OAuthClientId Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 24.0.9300.0