Gorgias
API integration

list_all_gorgias_users

List users ordered by name in Gorgias. Returns id, active status, bio, created_datetime, country, deactivated_datetime, email, external_id, firstname, lastname, language, meta.name, role, timezone, and updated_datetime fields.

get_single_gorgias_user_by_id

Get information about a specific user in Gorgias by id. Use id 0 to fetch the current user. Returns user details including id, name, email, and role.

create_a_gorgias_user

Create a user in Gorgias with required email, name, and role. Returns id, active status, bio, created_datetime, country, email, external_id, firstname, lastname, language, meta, full name, role name, timezone, updated_datetime, and client_id.

update_a_gorgias_user_by_id

Update a user by id in Gorgias. Returns fields including id, active status, bio, created_datetime, country, email, external_id, firstname, lastname, language, meta data, full name, role name, timezone, updated_datetime, and client_id.

delete_a_gorgias_user_by_id

Delete a user by id in Gorgias. Returns no content on success.

list_all_gorgias_tickets

The List Tickets endpoint retrieves a paginated list of support tickets from your Gorgias account, ordered by a specified field using the order_by parameter. It supports several optional filters to narrow down the results, including customer_id, trashed, external_id, view_id, rule_id, and a list of specific ticket_ids.

get_single_gorgias_ticket_by_id

Get detailed information about a specific ticket in Gorgias by id. Returns ticket id, uri, external_id, status, channel, via, customer info, assignee_user, subject, tags, messages, timestamps, satisfaction_survey, and unread status.

create_a_gorgias_ticket

Create a ticket in Gorgias with required messages array.

update_a_gorgias_ticket_by_id

Update a ticket in Gorgias. Requires id.

delete_a_gorgias_ticket_by_id

Delete a ticket by id in Gorgias. Returns no content on success.

list_all_gorgias_customers

List customers ordered by name in Gorgias. Supports filtering by email, external_id, language, name, timezone, view_id, channel_type, and channel_address. Returns customer fields including id, email, external_id, firstname, lastname, name, language, timezone, created_datetime, and updated_datetime.

get_single_gorgias_customer_by_id

Get information about a specific customer in Gorgias by id. Returns fields including id, channels, created_datetime, email, external_id, firstname, integrations, language, lastname, name, note, timezone, updated_datetime, and external_data.

create_a_gorgias_customer

Create a customer in Gorgias with required channels. Returns id, channels, email, external_id, firstname, integrations data, language, lastname, name, note, timezone, created_datetime, and updated_datetime.

update_a_gorgias_customer_by_id

Update a customer by id in Gorgias. Returns the updated customer object including id, name, email, language, timezone, and channels.

gorgias_customers_set_customer_data

Set a customer's data in Gorgias by customer id.

delete_a_gorgias_customer_by_id

Delete a customer by id in Gorgias.

list_all_gorgias_tags

List tags matching the given parameters in Gorgias. Returns tag name and created_datetime fields.

get_single_gorgias_tag_by_id

Get information about a specific tag by id in Gorgias. Returns fields created_datetime, decoration, color, deleted_datetime, description, name, and usage.

create_a_gorgias_tag

Create a tag in Gorgias with the required name. Returns created_datetime, decoration (color), deleted_datetime, description, name, and usage count of the tag.

update_a_gorgias_tag_by_id

Update a tag by id in Gorgias. Returns fields including created_datetime, decoration, color, deleted_datetime, description, urgent, and usage.

delete_a_gorgias_tag_by_id

Delete a tag by id in Gorgias. Tags used in macros or rules cannot be deleted. Deleting a tag deactivates any views using it.

gorgias_tags_merge

Merge one or more source tags into the destination tag in Gorgias. Requires destination tag id and source_tags_ids. Returns the merged tag with fields like created_datetime, decoration, color, description, name, and usage.

list_all_gorgias_messages

List messages filtered by ticket_id in Gorgias. Returns id, external_id, ticket_id, message content, sender, and channel details for each message.

get_single_gorgias_message_by_id

Get a specific message by ticket_id and id in Gorgias. Returns fields including id, message_id, ticket_id, external_id, public, channel, via, source, sender, receiver, subject, body_text, body_html, attachments, created_datetime, sent_datetime, failed_datetime, opened_datetime, last_sending_error, and integration_id.

create_a_gorgias_message

Create a message in Gorgias for the ticket identified by ticket_id. Returns message fields including id, body_html, body_text, channel, created_datetime, external_id, from_agent, integration_id, message_id, receiver, sender, source, and subject.

update_a_gorgias_message_by_id

Update a message by ticket_id and id in Gorgias. Returns fields including id, attachments, body_html, body_text, channel, created_datetime, external_id, failed_datetime, from_agent, integration_id, last_sending_error, message_id, receiver, rule_id, sender, source, stripped_html, stripped_text, subject, and ticket_id.

delete_a_gorgias_message_by_id

Delete a message by ticket_id and id in Gorgias.

list_all_gorgias_teams

List teams with optional limit and order_by parameters in Gorgias. Returns an array of teams including id, name, description, decoration, members, and created_datetime fields.

get_single_gorgias_team_by_id

Get information about a specific team by id in Gorgias. Returns id, uri, name, description, decoration (emoji), members (id, name, email), and created_datetime fields.

create_a_gorgias_team

Create a team with the required name in Gorgias. Returns the id and name of the created team.

update_a_gorgias_team_by_id

Update a team by id in Gorgias. Returns the updated team's id, name, description, decoration, and members with their id, name, and email.

list_all_gorgias_ticket_tags

Get all tags for a ticket in Gorgias. Requires ticket id. Returns tag id, created_datetime, decoration color, deleted_datetime, description, name, usage count, and uri.

create_a_gorgias_ticket_tag

Add tags to a ticket in Gorgias. Requires ticket_id.

update_a_gorgias_ticket_tag_by_id

Set a ticket's tags by ticket_id in Gorgias. The response confirms the update with no content returned.

delete_a_gorgias_ticket_tag_by_id

Remove tags from a ticket in Gorgias. Requires ticket id and tag names or ids. Returns no content on success.

list_all_gorgias_attachments

Retrieves a list of messages, each of which may contain attachments. This endpoint is used to access message data, including associated attachments metadata

gorgias_attachments_download

Downloads a specific attachment file using the file's direct path, which is typically provided in the response of the message listing endpoint. The actual path must be replaced with the URI or download link of the attachment.

list_all_gorgias_views

List all views ordered by their id in Gorgias. Returns fields including id, category, created_datetime, deactivated_datetime, decoration, fields, filters, name, order_by, order_dir, search, slug, type, and visibility.

get_single_gorgias_view_by_id

Get a view by id in Gorgias. Returns fields including id, category, created_datetime, deactivated_datetime, decoration (emoji), fields, filters, name, order_by, order_dir, search, slug, and type.

create_a_gorgias_view

Create a view in Gorgias with required slug. Returns id, category, created_datetime, deactivated_datetime, decoration (emoji), fields (attributes displayed), filters (filter logic), name, order_by, order_dir, search, slug, type, visibility.

update_a_gorgias_view_by_id

Update a view by id in Gorgias. Returns the updated view including id, category, created_datetime, deactivated_datetime, decoration (emoji), fields, filters, name, order_by, order_dir, search, slug, type, shared_with_teams, shared_with_users, uri, and visibility.

delete_a_gorgias_view_by_id

Delete a view by id in Gorgias. Requires the id of the view to delete.

list_all_gorgias_view_items

List items of a view by view_id in Gorgias. Returns paginated items ordered by view's attribute including id, subject, customer, assignee_user, assignee_team, tags, status, priority, channel, and timestamps.

create_a_gorgias_file

Upload files to Gorgias with type parameter specifying file type. Returns content_type, name, size, and url of each uploaded file.

gorgias_files_download

Download a private file by file_type, domain_hash, and id in Gorgias. Returns the file content for the specified resource_name.

list_all_gorgias_custom_fields

List custom fields filtered by object_type in Gorgias. Returns id, external_id, object_type, label, description, priority, required, managed_type, definition, created_datetime, updated_datetime, and deactivated_datetime for each custom field.

get_single_gorgias_custom_field_by_id

Get information about a specific custom field in Gorgias. Requires id. Returns fields including id, label, and type of the custom field.

create_a_gorgias_custom_field

Create a custom field in Gorgias with required object_type and label. Returns id, external_id, object_type, label, description, priority, required, managed_type, definition.input_settings, created_datetime, updated_datetime, and deactivated_datetime.

update_a_gorgias_custom_field_by_id

Update a custom field by id in Gorgias. Returns the updated custom field including id, label, description, data_type, and priority.

update_a_gorgias_ticket_field_by_id

Update a ticket's custom fields values in Gorgias. Requires ticket_id. Returns the updated custom fields.

list_all_gorgias_ticket_fields

List all custom fields for a ticket in Gorgias. Requires ticket id. Returns fields including id, external_id, label, description, required status, data_type, and timestamps.

list_all_gorgias_integrations

List integrations with optional parameters order_by, and type in Gorgias. Returns integration id, name, type, description, created_datetime, updated_datetime, deactivated_datetime, and HTTP integration details including url, method, triggers, and content types.

get_single_gorgias_integration_by_id

Get integration details by id in Gorgias. Returns id, name, type, created_datetime, updated_datetime, and http configuration including url, method, form data, triggers, request_content_type, and response_content_type.

create_a_gorgias_integration

Create an integration in Gorgias with required name and type. Returns id, created_datetime, updated_datetime, uri, and http configuration including url, method, form data, triggers, request_content_type, and response_content_type.

update_a_gorgias_integration_by_id

Update an integration by id in Gorgias. Returns the updated integration including id, created_datetime, deactivated_datetime, description, http configuration, name, type, updated_datetime, user, uri, application_id, and managed status.

delete_a_gorgias_integration_by_id

Delete an integration by id in Gorgias. Note that integrations used in rules or other integrations cannot be deleted. Deleting will deactivate any views using this integration.

list_all_gorgias_macros

List macros with parameters tags, languages, message_id, order_by, search, ticket_id, number_predictions, and archived in Gorgias. Returns id, external_id, name, intent, language, usage, actions, created_datetime, updated_datetime, archived_datetime, and uri fields.

create_a_gorgias_macro

Create a macro in Gorgias with required name, and optional external_id, intent, language, and actions. Returns id, external_id, name, intent, language, usage, actions, created_datetime, updated_datetime, archived_datetime, and uri.

get_single_gorgias_macro_by_id

Get information about a specific macro in Gorgias by id. Returns fields including id, external_id, name, intent, language, usage, actions, created_datetime, updated_datetime, archived_datetime, and uri.

update_a_gorgias_macro_by_id

Update a macro by id in Gorgias. Returns id, external_id, name, intent, language, usage, actions, created_datetime, updated_datetime, archived_datetime, and uri fields in the response.

delete_a_gorgias_macro_by_id

Delete a macro by id in Gorgias. Requires id.

update_a_gorgias_customer_field_by_id

Update a customer's custom fields values in Gorgias using customer_id. Returns updated fields including id, external_id, label, description, required status, data_type, and timestamps.

list_all_gorgias_search

Search resources in Gorgias using type and query. Returns matching resource fields such as id, name, and email in the response.

get_single_gorgias_account_by_id

Get information about your account in Gorgias. Returns created_datetime, deactivated_datetime, domain, settings (including business hours), and status indicating if the account is active.

list_all_gorgias_account_settings

List account settings in Gorgias filtered by type. Returns id, data including timezone and business_hours, and type for each setting.

create_a_gorgias_account_setting

Create a setting for the current account in Gorgias. Requires type and data in the request body.

update_a_gorgias_account_setting_by_id

Update a setting for the current account in Gorgias using id.

list_all_gorgias_surveys

List surveys in Gorgias ordered by creation date. Returns id, body_text, created_datetime, customer_id, score, scored_datetime, sent_datetime, should_send_datetime, ticket_id, uri, and meta fields.

get_single_gorgias_survey_by_id

Get a survey in Gorgias by id. Returns id, body_text, created_datetime, customer_id, meta, score, scored_datetime, sent_datetime, should_send_datetime, ticket_id, and uri in the response.

create_a_gorgias_survey

Create a new satisfaction survey in Gorgias with required parameters customer_id and ticket_id. Returns id, body_text, created_datetime, customer_id, meta, score, scored_datetime, sent_datetime, should_send_datetime, ticket_id, and uri.

update_a_gorgias_survey_by_id

Update a survey in Gorgias using id. Returns id, body_text, created_datetime, customer_id, meta, score, scored_datetime, sent_datetime, should_send_datetime, ticket_id, and uri in the response.

list_all_gorgias_jobs

List jobs in Gorgias ordered by creation date. Returns id, status, type, created_datetime, user_id, and progress info for each job.

get_single_gorgias_job_by_id

Get details about a specific job in Gorgias using id. Returns fields such as id, status, type, created_datetime, user_id, and job progress info.

create_a_gorgias_job

Create a job in Gorgias with specified type and params. Returns id, status, type, created_datetime, user_id, and job progress fields in the response. Jobs are processed asynchronously, meaning that once a job is created, it will run in background on Gorgias's servers. According to the type and size of the task, a job can take a few minutes or several hours to be executed. You can use our API to check the status of the job.

update_a_gorgias_job_by_id

Update a job in Gorgias using id. Returns fields such as id, status, meta, params, scheduled_datetime, and info for tracking job status and details.

delete_a_gorgias_job_by_id

Cancel a job in Gorgias. Requires id. Returns no content if successful. If the job already started, completed changes will not be reverted.

list_all_gorgias_rules

List rules in Gorgias. Returns id, code, code_ast, created_datetime, deactivated_datetime, description, event_types, name, priority, updated_datetime, and uri for each rule.

get_single_gorgias_rule_by_id

Get a specific rule in Gorgias using id. Returns id, code, code_ast, created_datetime, deactivated_datetime, description, event_types, name, priority, updated_datetime, and uri fields in the response.

create_a_gorgias_rule

Create a rule in Gorgias. Requires code and name. Returns id, code, code_ast, created_datetime, deactivated_datetime, description, event_types, name, priority, updated_datetime, and uri in the response.

update_a_gorgias_rule_by_id

Update a rule in Gorgias using id. Returns id, code (JavaScript logic), code_ast (AST representation), created_datetime, deactivated_datetime, description, event_types, name, priority, updated_datetime, and uri in the response.

delete_a_gorgias_rule_by_id

Delete a rule in Gorgias. Requires id. Returns no content in the response.

gorgias_rules_update_priorities

Update priorities for multiple rules in Gorgias. Requires an array of objects with id and priority. Returns id, code, code_ast, created_datetime, deactivated_datetime, description, event_types, name, priority, updated_datetime, and uri for each updated rule.

list_all_gorgias_events

List events filtered by created_datetime, object_id, object_type, and types in Gorgias. Returns event id, created_datetime, type, user_id, and uri fields ordered by creation date descending.

get_single_gorgias_event_by_id

Get information about a specific event in Gorgias by id. Returns event fields including id, context (uuid4 grouping related events), created_datetime, data (key-value), object_id, object_type, type, user_id, and uri.

list_all_gorgias_satisfaction_survey

List satisfaction surveys filtered by ticket_id in Gorgias. Returns id, body_text, created_datetime, customer_id, score, scored_datetime, sent_datetime, should_send_datetime, and ticket_id for each survey.

get_single_gorgias_satisfaction_survey_by_id

Get a satisfaction survey by id in Gorgias. Returns id, body_text (customer comment), created_datetime, customer_id, meta (additional data), score (1-5 satisfaction level), scored_datetime, sent_datetime, should_send_datetime, ticket_id, and uri.

create_a_gorgias_satisfaction_survey

Create a new satisfaction survey in Gorgias with required parameters customer_id and ticket_id. Returns id, body_text, created_datetime, customer_id, meta, score, scored_datetime, sent_datetime, should_send_datetime, ticket_id, and uri of the created survey.

update_a_gorgias_satisfaction_survey_by_id

Update a satisfaction survey by id in Gorgias. Returns the updated survey including id, body_text, created_datetime, customer_id, meta, score, scored_datetime, sent_datetime, should_send_datetime, ticket_id, and uri.

list_all_gorgias_statistics

Retrieve the data of a statistic by name in Gorgias. Requires name and filters. Returns data with axes and lines representing the statistic, along with label and legend fields describing the metric.

gorgias_statistics_download

Download CSV-formatted data of a statistic in Gorgias. Requires name of the statistic and filters object. Returns CSV data for the specified statistic.

list_all_gorgias_voice_calls

List voice calls filtered by ticket_id in Gorgias. Returns id, integration_id, ticket_id, phone_number_id, external_id, provider, status, direction, phone_number_source, country_source, phone_number_destination, country_destination, duration, started_datetime, created_datetime, updated_datetime, initiated_by_agent_id, last_answered_by_agent_id, customer_id, has_voicemail, has_call_recording, summaries, termination_status, and queue_id fields.

get_single_gorgias_voice_call_by_id

Get information about a specific voice call in Gorgias by id. Returns fields including id, integration_id, ticket_id, phone_number_id, external_id, provider, status, direction, phone_number_source, country_source, phone_number_destination, country_destination, duration, started_datetime, created_datetime, updated_datetime, initiated_by_agent_id, last_answered_by_agent_id, customer_id, has_voicemail, has_call_recording, termination_status, and queue_id.

list_all_gorgias_voice_call_recordings

List voice call recordings in Gorgias filtered by optional call_id. Returns id, call_id, external_id, url, duration, type, created_datetime, deleted_datetime, error_code, and transcription_status for each recording.

get_single_gorgias_voice_call_recording_by_id

Get a voice call recording by id in Gorgias. Returns id, call_id, external_id, url, duration, type, created_datetime, deleted_datetime, error_code, and transcription_status fields.

delete_a_gorgias_voice_call_recording_by_id

Delete a voice call recording by id in Gorgias. Returns no content if successful.

list_all_gorgias_voice_call_events

List voice call events in Gorgias. Returns fields id, type, account_id, call_id, user_id, customer_id, created_datetime, and meta for each event.

get_single_gorgias_voice_call_event_by_id

Get information about a specific voice call event in Gorgias using id. Returns id, type, account_id, call_id, user_id, customer_id, created_datetime, and meta fields.

list_all_gorgias_widgets

List all widgets in Gorgias. Returns id, context, created_datetime, deactivated_datetime, app_id, order, template (type, widgets), type, updated_datetime, and uri for each widget.

get_single_gorgias_widget_by_id

Get information about a specific widget in Gorgias. Requires id. Returns id, context (ticket, customer), created_datetime, deactivated_datetime, app_id, order, template (type and widgets), type, updated_datetime, and uri.

create_a_gorgias_widget

Create a widget in Gorgias with required template and type. Returns id, context, created_datetime, deactivated_datetime, app_id, order, template, type, updated_datetime, and uri of the created widget.

update_a_gorgias_widget_by_id

Update a widget by id in Gorgias. Returns the updated widget including id, context, created_datetime, deactivated_datetime, app_id, order, template with type and widgets, type, updated_datetime, and uri.

delete_a_gorgias_widget_by_id

Delete a widget by id in Gorgias. Returns no content on success.

list_all_gorgias_view_items_search

List view's items for view with id in Gorgias. Returns items with fields including id, subject, customer info, assignee user and team, tags, status, priority, channel, and timestamps. Requires view_id and view object in body.

update_a_gorgias_ticket_field_value_by_id

Update a specific ticket's custom field value in Gorgias. Requires ticket_id and id. Returns field details including id, definition, label, and updated value in the response.