Skip to main content
Connecting to Gorgias
Cynthia Tsai avatar
Written by Cynthia Tsai
Updated over 9 months ago

For the platform to integrate with Gorgias, we adopt the basic authentication (private app API Key) authentication to access the Gorgias API.

Each access token (or API key) is tied to a specific user and has the same permissions as the user that holds them. Requests made with an access token will act on behalf of a user and will have access to the resources their permissions allow. Gorgias account admin can easily generate and revoke access token via account settings.

Method: Basic Authentication

  1. Navigate to your Company's Gorgias account Settings -> REST API.

  2. Click the Create API key button.

  3. Copy/paste your username and API key in a secure location.

  4. Securely share your username and API Key via secure email*. We recommend using the Virtru email extension to securely email us the required username and API Key information.

  5. Securely share your account-name URL value with the team.

    1. --url https://account-name.gorgias.com

* If you do not have the means to share securely, we recommend using the Virtru email extension to securely email us the required api_id and api_token credential information.

__________________________________________________________________________________

We hope this was helpful! Please submit a ticket here if you have any questions or need further assistance.

Did this answer your question?