Gorgias Get Account Info

This action retrieves account information from Gorgias, including metadata and account-wide settings. It provides details about the account's creation, subscription status, domain, and various settings.

Action Inputs

Name	Type	Description
Domain	String	Your Gorgias sub-domain. You can find this in your Gorgias account settings.
Username	String	Your Gorgias user email. This will be the email of the agent on whose behalf the action is connecting to your account.
Password	String	Your Gorgias API key. You can generate this in your Gorgias account settings. Keep this secure and do not share it publicly.

Action Outputs

Name	Type	Description
Success	Boolean (true/false)	Indicates whether the account information was successfully retrieved.
AccountInfo	Object	The retrieved Gorgias account information. See below for details.

AccountInfo Object

The AccountInfo object contains the following properties:

created_datetime: ISO 8601 datetime when the account was created.
current_subscription: Object containing subscription details:
- status: The status of the subscription (e.g., "active").
- trial_start_datetime: Start date of the trial period (if applicable).
- trial_end_datetime: End date of the trial period (if applicable).
- start_datetime: Start date of the current subscription.
- plan: Details about the current plan (if available).
deactivated_datetime: ISO 8601 datetime when the account was deactivated (null if active).
domain: The Gorgias domain of the account.
meta: Object containing additional metadata:
- analytics_group_id: Identifier for analytics grouping.
- company_domain: The primary domain of the company.
- hasCreditCard: Boolean indicating if a credit card is on file.
settings: Array of objects containing account-wide settings (e.g., business hours, satisfaction survey).
status: Object indicating the current status of the account.

Example Response

{
  "success": true,
  "accountInfo": {
    "created_datetime": "2023-10-23T18:17:53.946156+00:00",
    "current_subscription": {
      "status": "active",
      "trial_start_datetime": null,
      "trial_end_datetime": null,
      "start_datetime": "2024-09-30T14:34:56+00:00",
      "plan": null
    },
    "deactivated_datetime": null,
    "domain": "naturepedic",
    "meta": {
      "analytics_group_id": "ec8ebcbe-072e-426b-a419-2b5dec11a30e",
      "company_domain": "naturepedic.com",
      "hasCreditCard": true
    },
    "settings": [
      // Array of setting objects
    ],
    "status": {
      "status": "active"
    }
  }
}

Usage Notes

Ensure that you have the necessary permissions to access account information in your Gorgias account.
Keep your API key secure and do not expose it in client-side code or public repositories.
The settings array may contain various account-wide configurations. Refer to the Gorgias API documentation for detailed information on possible setting types.
If you encounter any issues or need further assistance, please contact Gorgias support or refer to their API documentation.