Gorgias

Get a single rule by ID. Args: - id: The rule ID - format: Response format ('json' or 'markdown') Returns: The rule record with all available fields including code/codeAst.

List all ticket views from Gorgias. Views are saved ticket filters that help organize and categorize tickets. Returns: JSON format: Array of views Markdown format: Formatted table of views

Get a single view by ID. Args: - id: The view ID - format: Response format ('json' or 'markdown') Returns: The view record with all available fields.

Get a single custom field by ID. Args: - id: The custom field ID - format: Response format ('json' or 'markdown') Returns: The custom field record with all available fields.

List all custom fields from Gorgias. Custom fields allow you to store additional structured data on tickets and customers. Args: - objectType: Filter by object type ('ticket' or 'customer') - format: Response format ('json' or 'markdown') Returns: JSON format: Array of custom fields Markdown format: Formatted table of custom fields

List customers from Gorgias with pagination and filtering. Returns a paginated list of customers. Use the cursor from the response to fetch the next page. Args: - limit: Number of customers to return (1-100, default: 20) - cursor: Pagination cursor from previous response - email: Filter by email address - format: Response format ('json' or 'markdown') Returns: JSON format: { items: Customer[], nextCursor } Markdown format: Formatted table of customers

Get account information for the Gorgias helpdesk. Returns: The account record including domain, status, and settings.

Get statistics for the Gorgias helpdesk. Args: - statisticType: Type of statistics to retrieve (required) - startDatetime: Start date for statistics (ISO datetime, required) - endDatetime: End date for statistics (ISO datetime, required) - timezone: Timezone for the statistics (optional) - format: Response format ('json' or 'markdown') Returns: Statistics data for the specified time range.

Test the connection to the Gorgias API. Returns: Connection status and account information.

Create a new custom field in Gorgias. Args: - objectType: Object type ('ticket' or 'customer') (required) - label: Field label (required) - description: Field description - priority: Display priority - required: Whether the field is required - definitionType: Field type (e.g., 'text', 'number', 'dropdown') - definitionChoices: Array of choices for dropdown fields Returns: The created custom field record.

Update an existing custom field. Args: - id: Custom field ID to update - label: New field label - description: New field description - priority: New display priority - required: New required setting Returns: The updated custom field record.

Get a single customer by ID. Args: - id: The customer ID - format: Response format ('json' or 'markdown') Returns: The customer record with all available fields.

Create a new customer in Gorgias. Args: - email: Customer email address - name: Full name - firstname: First name - lastname: Last name - externalId: External ID from your system - note: Notes about the customer - language: Preferred language code - timezone: Customer timezone Returns: The created customer record.

Update an existing customer. Args: - id: Customer ID to update - email: New email address - name: New full name - firstname: New first name - lastname: New last name - externalId: New external ID - note: New notes - language: New language code - timezone: New timezone Returns: The updated customer record.

Delete a customer from Gorgias. Args: - id: Customer ID to delete Returns: Confirmation of deletion.

Merge two customers into one. Args: - targetId: The customer ID to keep (target) - sourceId: The customer ID to merge into target Returns: The merged customer record.

List events from Gorgias with pagination and filtering. Events represent actions that occurred in Gorgias (e.g., ticket created, message sent). Args: - limit: Number of events to return (1-100, default: 20) - cursor: Pagination cursor from previous response - objectType: Filter by object type (e.g., 'ticket', 'message') - objectId: Filter by object ID - type: Filter by event type - format: Response format ('json' or 'markdown') Returns: JSON format: { items: Event[], nextCursor } Markdown format: Formatted table of events

Get a single event by ID. Args: - id: The event ID - format: Response format ('json' or 'markdown') Returns: The event record with all available fields.

List all integrations from Gorgias. Integrations connect Gorgias to external services like Shopify, Magento, BigCommerce, etc. Returns: JSON format: Array of integrations Markdown format: Formatted table of integrations

Get a single integration by ID. Args: - id: The integration ID - format: Response format ('json' or 'markdown') Returns: The integration record with all available fields.

Create a new HTTP integration in Gorgias. Args: - name: Integration name (required) - type: Integration type (required) - httpUrl: HTTP endpoint URL - httpMethod: HTTP method (GET, POST, etc.) - httpHeaders: HTTP headers as key-value pairs (string values only) Returns: The created integration record.

Update an existing integration. Args: - id: Integration ID to update - name: New integration name Returns: The updated integration record.

Delete an integration from Gorgias. Args: - id: Integration ID to delete Returns: Confirmation of deletion.

List background jobs from Gorgias with pagination. Jobs represent background tasks like bulk operations or imports. Args: - limit: Number of jobs to return (1-100, default: 20) - cursor: Pagination cursor from previous response - format: Response format ('json' or 'markdown') Returns: JSON format: { items: Job[], nextCursor } Markdown format: Formatted table of jobs

Get a single job by ID. Args: - id: The job ID - format: Response format ('json' or 'markdown') Returns: The job record with all available fields including status and progress.

Create a new background job in Gorgias. Args: - type: Job type (required) - paramsJson: Job parameters as JSON string (required) - scheduledDatetime: When to run the job (ISO datetime) Returns: The created job record.

Cancel a running job. Args: - id: Job ID to cancel Returns: Confirmation of cancellation.

List macros from Gorgias with pagination. Macros are pre-defined responses and actions that agents can use to respond quickly to common customer inquiries. Args: - limit: Number of macros to return (1-100, default: 20) - cursor: Pagination cursor from previous response - format: Response format ('json' or 'markdown') Returns: JSON format: { items: Macro[], nextCursor } Markdown format: Formatted table of macros

Get a single macro by ID. Args: - id: The macro ID - format: Response format ('json' or 'markdown') Returns: The macro record with all available fields including actions.

Create a new macro in Gorgias. Args: - name: Macro name (required) - actions: Array of macro actions as JSON (required) - intent: Intent/category of the macro - language: Language code for the macro Returns: The created macro record.

Update an existing macro. Args: - id: Macro ID to update - name: New macro name - actionsJson: New array of macro actions as JSON - intent: New intent/category - language: New language code Returns: The updated macro record.

Delete a macro from Gorgias. Args: - id: Macro ID to delete Returns: Confirmation of deletion.

List messages from Gorgias with pagination and filtering. Returns a paginated list of messages. Use the cursor from the response to fetch the next page. Args: - limit: Number of messages to return (1-100, default: 20) - cursor: Pagination cursor from previous response - ticketId: Filter by ticket ID - format: Response format ('json' or 'markdown') Returns: JSON format: { items: Message[], nextCursor } Markdown format: Formatted table of messages

Get a single message by ID. Args: - id: The message ID - format: Response format ('json' or 'markdown') Returns: The message record with all available fields.

Create a new message on a ticket. Args: - ticketId: The ticket ID to add the message to - channel: The channel for the message (e.g., 'email', 'internal-note') - via: How the message was received (e.g., 'email', 'api', 'helpdesk') - bodyText: Message body (plain text) - bodyHtml: Message body (HTML, optional) - fromAgent: Whether this message is from an agent (default: true) - senderId: Sender user ID (for agent messages) - receiverId: Receiver user/customer ID - subject: Message subject (optional) Returns: The created message record.

Delete a message from Gorgias. Args: - id: Message ID to delete Returns: Confirmation of deletion.

List automation rules from Gorgias with pagination. Rules are automation workflows that trigger actions based on events (e.g., auto-tagging, auto-assignment). Args: - limit: Number of rules to return (1-100, default: 20) - cursor: Pagination cursor from previous response - format: Response format ('json' or 'markdown') Returns: JSON format: { items: Rule[], nextCursor } Markdown format: Formatted table of rules

Create a new automation rule in Gorgias. Args: - name: Rule name (required) - eventTypes: Event types that trigger the rule (required, e.g., 'ticket-created') - description: Rule description - code: Rule code (Python-like syntax) - codeAstJson: Rule code AST as JSON (alternative to code) - priority: Rule priority (lower runs first) Returns: The created rule record.

Update an existing rule. Args: - id: Rule ID to update - name: New rule name - eventTypes: New event types - description: New rule description - code: New rule code - codeAstJson: New rule code AST as JSON - priority: New rule priority Returns: The updated rule record.

Delete a rule from Gorgias. Args: - id: Rule ID to delete Returns: Confirmation of deletion.

List satisfaction surveys from Gorgias with pagination. Satisfaction surveys collect customer feedback after ticket resolution. Args: - limit: Number of surveys to return (1-100, default: 20) - cursor: Pagination cursor from previous response - ticketId: Filter by ticket ID - customerId: Filter by customer ID - format: Response format ('json' or 'markdown') Returns: JSON format: { items: SatisfactionSurvey[], nextCursor } Markdown format: Formatted table of surveys

Get a single satisfaction survey by ID. Args: - id: The survey ID - format: Response format ('json' or 'markdown') Returns: The satisfaction survey record with all available fields.

Create a new satisfaction survey in Gorgias. Args: - ticketId: The ticket ID to survey (required) - customerId: The customer ID (required) - shouldSendDatetime: When to send the survey (ISO datetime) Returns: The created satisfaction survey record.

List all tags from Gorgias. Returns: JSON format: Array of tags Markdown format: Formatted table of tags

Get a single tag by ID. Args: - id: The tag ID - format: Response format ('json' or 'markdown') Returns: The tag record with all available fields.

Create a new tag in Gorgias. Args: - name: Tag name (required) - description: Tag description - color: Tag color (hex code) Returns: The created tag record.

Update an existing tag. Args: - id: Tag ID to update - name: New tag name - description: New tag description - color: New tag color (hex code) Returns: The updated tag record.

Delete a tag from Gorgias. Args: - id: Tag ID to delete Returns: Confirmation of deletion.

Merge multiple tags into one. Args: - primaryId: The tag ID to keep (primary) - secondaryIds: Array of tag IDs to merge into the primary Returns: The merged tag record.

List all teams from Gorgias. Returns: JSON format: Array of teams Markdown format: Formatted table of teams

Get a single team by ID. Args: - id: The team ID - format: Response format ('json' or 'markdown') Returns: The team record with all available fields.

Create a new team in Gorgias. Args: - name: Team name (required) - description: Team description - memberIds: Array of user IDs to add as members Returns: The created team record.

Update an existing team. Args: - id: Team ID to update - name: New team name - description: New team description - memberIds: New array of member user IDs Returns: The updated team record.

Delete a team from Gorgias. Args: - id: Team ID to delete Returns: Confirmation of deletion.

Create a new view in Gorgias. Args: - name: View name (required) - filters: Filter expression string - orderBy: Field to order by - orderDir: Order direction ('asc' or 'desc') - visibility: View visibility ('public', 'shared', 'private') - fields: Array of fields to display Returns: The created view record.

List tickets from Gorgias with pagination and filtering. Returns a paginated list of tickets. Use the cursor from the response to fetch the next page. Args: - limit: Number of tickets to return (1-100, default: 20) - cursor: Pagination cursor from previous response - status: Filter by status ('open' or 'closed') - assigneeUserId: Filter by assigned user ID - assigneeTeamId: Filter by assigned team ID - customerId: Filter by customer ID - channel: Filter by channel - format: Response format ('json' or 'markdown') Returns: JSON format: { items: Ticket[], nextCursor } Markdown format: Formatted table of tickets

Get a single ticket by ID with all messages included. Args: - id: The ticket ID - format: Response format ('json' or 'markdown') Returns: The ticket record with all available fields and messages.

Create a new ticket in Gorgias. Args: - channel: The channel for the ticket (e.g., 'email', 'chat', 'phone') - customerId: Customer ID (optional if customerEmail provided) - customerEmail: Customer email (used if customerId not provided) - subject: Ticket subject - messageBodyText: Initial message body (plain text) - messageBodyHtml: Initial message body (HTML, optional) - messageVia: How the message was received (e.g., 'email', 'api') Returns: The created ticket record.

Update an existing ticket. Args: - id: Ticket ID to update - status: New status ('open' or 'closed') - priority: New priority ('low', 'normal', 'high', 'urgent') - assigneeUserId: New assignee user ID (null to unassign) - assigneeTeamId: New assignee team ID (null to unassign) - snoozeUntilDatetime: Snooze until this datetime (ISO format, null to unsnooze) Returns: The updated ticket record.

Delete a ticket from Gorgias. Args: - id: Ticket ID to delete Returns: Confirmation of deletion.

Add tags to a ticket. Args: - ticketId: The ticket ID - tagIds: Array of tag IDs to add Returns: Confirmation of success.

Remove tags from a ticket. Args: - ticketId: The ticket ID - tagIds: Array of tag IDs to remove Returns: Confirmation of success.

List users (agents) from Gorgias with pagination. Returns a paginated list of users/agents. Use the cursor from the response to fetch the next page. Args: - limit: Number of users to return (1-100, default: 20) - cursor: Pagination cursor from previous response - format: Response format ('json' or 'markdown') Returns: JSON format: { items: User[], nextCursor } Markdown format: Formatted table of users

Get a single user (agent) by ID. Args: - id: The user ID - format: Response format ('json' or 'markdown') Returns: The user record with all available fields.

Update an existing view. Args: - id: View ID to update - name: New view name - filters: New filter expression - orderBy: New field to order by - orderDir: New order direction - visibility: New visibility - fields: New fields to display Returns: The updated view record.

Delete a view from Gorgias. Args: - id: View ID to delete Returns: Confirmation of deletion.

List tickets matching a view's filters. Args: - viewId: The view ID - limit: Number of tickets to return (1-100, default: 20) - cursor: Pagination cursor from previous response - format: Response format ('json' or 'markdown') Returns: JSON format: { items: Ticket[], nextCursor } Markdown format: Formatted table of tickets

List all widgets from Gorgias. Widgets display custom information in the helpdesk UI (e.g., customer data from external systems). Returns: JSON format: Array of widgets Markdown format: Formatted table of widgets

Get a single widget by ID. Args: - id: The widget ID - format: Response format ('json' or 'markdown') Returns: The widget record with all available fields.

Create a new widget in Gorgias. Args: - context: Widget context ('ticket', 'customer', or 'user') (required) - template: Widget template HTML (required) - order: Display order - integrationId: Associated integration ID Returns: The created widget record.

Update an existing widget. Args: - id: Widget ID to update - context: New widget context - template: New widget template HTML - order: New display order Returns: The updated widget record.

Delete a widget from Gorgias. Args: - id: Widget ID to delete Returns: Confirmation of deletion.