API Data Provider - Online Help

Connecting to LINEWORKS

The LINEWORKS API uses a API key and Token-based authentication.

Using Token Authentication

Your LINEWORKS AppID and AppSecret are required to create a connection to LINEWORKS. AppID and AppSecret can get from LINEWORKS Support team. Once you have obtained those properties, set them in the ProfileSettings connection property.

Example Connection string

Profile=C:\profiles\LINEWORKS.apip;ProfileSettings='Partition=5226;AppID=my_app_id;AppSecret=my_app_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
AuthScheme The scheme used for authentication. Accepted entries are OAuth or None.
Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT
Scope OAuth Scopes of LINE WORKS.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9655.0