Connecting to Gorgias

Using Basic Authentication

Gorgias uses Basic authentication with your account email address and API key. Your API key can be found in your Gorgias account settings under Settings > REST API. Set the following connection properties:

AuthScheme: Set this to Basic.
User: Set this to your Gorgias account email address.
Password: Set this to your Gorgias API key.
Domain: Set this to your Gorgias subdomain. For example, if your Gorgias portal is acmeinc.gorgias.com, set this to 'acmeinc'.

Example Connection String

Profile=C:\profiles\Gorgias.apip;AuthScheme=Basic;[email protected];Password=your_api_key;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
AuthScheme	The scheme used for authentication. Accepted entries are Basic or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT, OAUTH_PASSWORD
Domain	Your Gorgias domain name.
Password	The Gorgias API key used as the password for Basic authentication.
User	The Gorgias account email address used as the username for Basic authentication.