API Data Provider - Online Help

Connecting to Pipeliner

Pipeliner uses Basic Authentication to authorize access to its service.

Using Basic Authentication

Pipeliner uses an API Token and API Password as Basic authentication credentials to authenticate. To find these credentials, go to your Pipeliner CRM space, and navigate to 'Administration' > 'Obtain API Key'. Set User to your Pipeliner API Token and Password as the API Password. Additionally, you'll need to set the SpaceID and the ServiceURL in the ProfileSettings connection property. For the ServiceUrl, copy the portion after the https://.

Example Connection String

Profile=C:\Profiles\Pipeliner.apip;User=my_api_token;Password=my_api_pw;ProfileSettings='SpaceId=my_spaceId;ServiceUrl=my_serviceurl;';

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
Password The password used to authenticate the user.
ServiceUrl The Service URL of the server your Pipeliner instance is hosted on.
SpaceId The team space Id for the space you wish to query from.
User The API user account used to authenticate.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060.0