API Data Provider - Online Help

Connecting to Gorgias

Gorgias uses Basic Authentication to authorize access.

Using Basic Authentication

To authorize access to your Gorgias data, use your email login and your API key as User and Password properties respectively. Additionally, you will need to set the Domain, which you can find from your Gorgias URL, in the ProfileSettings connection property. For example if your Gorgias portal is acmeinc.gorgias.com, then the Domain should be 'acmeinc'.

Example connection string:

Profile=C:\profiles\Gorgias.apip;User=your_email.com;Password=your_api_key;ProfileSettings='Domain=your_domain';

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
Domain Your Gorgias domain name.
Password Specifies the password of the authenticating user account.
User Specifies the user ID of the authenticating API user account.

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