---
updatedAt: 2026-04-20T19:43:50.000Z
agentTools:
  projectIndex: https://developers.gorgias.com/llms.txt
---

# Retrieve your account

# OpenAPI definition

```json
{
  "security": [
    {
      "basicAuth": []
    }
  ],
  "info": {
    "description": "The Gorgias REST API. Please go to https://developers.gorgias.com for more details.",
    "title": "Gorgias REST API",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://{domain}.gorgias.com",
      "variables": {
        "domain": {
          "default": "your-domain"
        }
      }
    }
  ],
  "x-readme": {
    "proxy-enabled": false
  },
  "paths": {
    "/api/account": {
      "get": {
        "summary": "Retrieve your account",
        "operationId": "get-account",
        "responses": {
          "200": {
            "description": "Your account",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Account"
                },
                "examples": {
                  "responses": {
                    "value": {
                      "created_datetime": "2017-11-23T15:59:41.966927",
                      "deactivated_datetime": null,
                      "domain": "company_name",
                      "settings": [
                        {
                          "id": 987,
                          "type": "business-hours",
                          "data": {
                            "timezone": "UTC",
                            "business_hours": {
                              "days": "1,2,3,4,5",
                              "from_time": "09:00",
                              "to_time": "22:00"
                            }
                          }
                        }
                      ],
                      "status": {
                        "status": "active"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Account"
        ]
      }
    }
  },
  "tags": [
    {
      "name": "Account"
    }
  ],
  "openapi": "3.1.0",
  "components": {
    "schemas": {
      "Account": {
        "type": "object",
        "properties": {
          "created_datetime": {
            "type": "string",
            "format": "date-time",
            "description": "When the account was created.",
            "example": "2017-11-23T15:59:41.966927"
          },
          "deactivated_datetime": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "When the account was deactivated.",
            "example": null
          },
          "domain": {
            "type": "string",
            "description": "Gorgias domain of the account.",
            "example": "company_name"
          },
          "settings": {
            "readOnly": true,
            "description": "Account-wide settings. E.g: business hours, satisfaction survey, etc...",
            "example": [
              {
                "id": 987,
                "type": "business-hours",
                "data": {
                  "timezone": "UTC",
                  "business_hours": {
                    "days": "1,2,3,4,5",
                    "from_time": "09:00",
                    "to_time": "22:00"
                  }
                }
              }
            ],
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer",
                  "description": "ID of the setting.",
                  "example": 987
                },
                "data": {
                  "example": {
                    "timezone": "UTC",
                    "business_hours": {
                      "days": "1,2,3,4,5",
                      "from_time": "09:00",
                      "to_time": "22:00"
                    }
                  }
                },
                "type": {
                  "type": "string",
                  "example": "business-hours"
                }
              },
              "required": [
                "type"
              ],
              "description": "An account setting is an object containing helpdesk-wide settings."
            }
          },
          "status": {
            "type": "object",
            "description": "The status of the account whether it is active or not and the reason.",
            "example": {
              "status": "active"
            }
          }
        },
        "description": "An account represents a Gorgias helpdesk. It contains metadata and account-wide settings."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic",
        "description": "The username will be the email address of your Gorgias account and the password will be your API key."
      }
    }
  }
}
```