Skip to main content

​
Integration Specifications

​
Prerequisites

​
Getting your API key

  1. After logging in to Gorgias, click the settings icon (the gear icon) at the bottom left of the screen. For details, see REST API authentication credentials (external site).
    Gorgias settings icon at the bottom left of the admin screen
  2. From the Settings list, select REST API.
    Gorgias settings menu with REST API selected
  3. On the REST API screen, check the subdomain part of the Base API URL (for example, i-1 in https://i-1.gorgias.com/api/). This is your workspace key, so save it for later. Also check the Username (your email address) field.
  4. If no Password (API Key) has been generated yet, click Create API key. If a key already exists, click Copy. Gorgias REST API screen showing the API key

​
Setting up the integration

  1. On the integration screen, search for Gorgias.
  2. Enter the workspace key, username, and API key you obtained in the previous step, then click Connect. Gorgias integration setup screen
  3. Once the integration with Gorgias succeeds, registered user information appears in the account list. If it doesn’t complete successfully, first try the steps in Troubleshoot SaaS integration errors. If that doesn’t resolve it, check Information to provide and contact support.
Last modified on October 27, 2026