Skip to main content
New to Corsair? See API access, authentication, and error handling.

Account

createAccountSetting

account.createAccountSetting Gorgias REST: Create a setting. Risk: write
Input
Output: object

getAccount

account.getAccount Gorgias REST: Retrieve your account. Risk: read
Input: empty object Output

listAccountSettings

account.listAccountSettings Gorgias REST: List settings. Risk: read
Input
Output

updateAccountSetting

account.updateAccountSetting Gorgias REST: Update a setting. Risk: write
Input
Output: object

Customers

createCustomer

customers.createCustomer Gorgias REST: Create a customer. Risk: write
Input
Output

deleteCustomer

customers.deleteCustomer Gorgias REST: Delete a customer. Risk: destructive
Input
Output: void

deleteCustomerCustomFieldValue

customers.deleteCustomerCustomFieldValue Gorgias REST: Delete customer field value. Risk: destructive
Input
Output: void

deleteCustomers

customers.deleteCustomers Gorgias REST: Delete customers. Risk: destructive
Input
Output: void

getCustomer

customers.getCustomer Gorgias REST: Retrieve a customer. Risk: read
Input
Output

listCustomerCustomFieldsValues

customers.listCustomerCustomFieldsValues Gorgias REST: List customer field values. Risk: read
Input
Output

listCustomers

customers.listCustomers Gorgias REST: List customers. Risk: read
Input
Output

mergeCustomers

customers.mergeCustomers Gorgias REST: Merge two customers. Risk: destructive
Input Merges and deletes the source customer; this action cannot be undone.
Output

updateCustomer

customers.updateCustomer Gorgias REST: Update a customer. Risk: write
Input
Output

updateCustomerCustomFieldValue

customers.updateCustomerCustomFieldValue Gorgias REST: Update customer field value. Risk: write
Input
Output

updateCustomerCustomFieldValues

customers.updateCustomerCustomFieldValues Gorgias REST: Update customer fields values. Risk: write
Input
Output

updateCustomerData

customers.updateCustomerData Gorgias REST: Replace a customer’s data object. Risk: destructive
Input
Output: void

Custom Fields

createCustomField

customFields.createCustomField Gorgias REST: Create a custom field. Risk: write
Input
Output

getCustomField

customFields.getCustomField Gorgias REST: Retrieve a custom field. Risk: read
Input
Output

listCustomFields

customFields.listCustomFields Gorgias REST: List custom fields. Risk: read
Input
Output

updateCustomField

customFields.updateCustomField Gorgias REST: Update a custom field. Risk: write
Input
Output

updateCustomFields

customFields.updateCustomFields Gorgias REST: Bulk update a list of custom fields. Risk: write
Input
Output: object[]

Events

getEvent

events.getEvent Gorgias REST: Retrieve an event. Risk: read
Input
Output

listEvents

events.listEvents Gorgias REST: List events. Risk: read
Input
Output

Files

downloadFile

files.downloadFile Gorgias REST: Download a file. Risk: read
Input Returns { kind: "binary", contentType, base64, sizeBytes }. The signed redirect URL is followed internally and is never returned or logged. Downloads above the client safety limit of 20 MiB are rejected.
Output

uploadFiles

files.uploadFiles Gorgias REST: Upload files. Risk: write
Input Provide one to ten files in body.files using filename, contentType, and base64-encoded contentBase64. The client caps combined upload data at 20 MiB.
Output: object[]

Integrations

createIntegration

integrations.createIntegration Gorgias REST: Create an integration. Risk: write
Input
Output

deleteIntegration

integrations.deleteIntegration Gorgias REST: Delete an integration. Risk: destructive
Input
Output: void

getIntegration

integrations.getIntegration Gorgias REST: Retrieve an integration. Risk: read
Input
Output

listIntegrations

integrations.listIntegrations Gorgias REST: List integrations. Risk: read
Input
Output

updateIntegration

integrations.updateIntegration Gorgias REST: Update an integration. Risk: write
Input
Output

Jobs

cancelJob

jobs.cancelJob Gorgias REST: Cancel a job. Risk: destructive
Input
Output: void

createJob

jobs.createJob Gorgias REST: Create a background job (apply a macro, delete or update tickets, export). Risk: destructive
Input
Output

getJob

jobs.getJob Gorgias REST: Retrieve a job. Risk: read
Input
Output

listJobs

jobs.listJobs Gorgias REST: List jobs. Risk: read
Input
Output

updateJob

jobs.updateJob Gorgias REST: Update a job. Risk: write
Input
Output

Macros

bulkArchiveMacros

macros.bulkArchiveMacros Gorgias REST: Archive macros. Risk: destructive
Input
Output

bulkUnarchiveMacros

macros.bulkUnarchiveMacros Gorgias REST: Unarchive macros. Risk: destructive
Input
Output

createMacro

macros.createMacro Gorgias REST: Create a macro. Risk: write
Input
Output

deleteMacro

macros.deleteMacro Gorgias REST: Delete a macro. Risk: destructive
Input
Output: void

getMacro

macros.getMacro Gorgias REST: Retrieve a macro. Risk: read
Input
Output

listMacros

macros.listMacros Gorgias REST: List macros. Risk: read
Input
Output

updateMacro

macros.updateMacro Gorgias REST: Update a macro. Risk: write
Input
Output

Metric Cards

createMetricCardFeedback

metricCards.createMetricCardFeedback Gorgias REST: Submit feedback on a metric card definition. Risk: write
Input
Output

getMetricCard

metricCards.getMetricCard Gorgias REST: Retrieve a metric card by slug. Risk: read
Input
Output

searchMetricCards

metricCards.searchMetricCards Gorgias REST: Search metric cards. Risk: read
Input
Output

Reporting Statistics

getStatistic

reportingStatistics.getStatistic Gorgias REST: Retrieve a statistic. Risk: read
Input
Output

Rules

createRule

rules.createRule Gorgias REST: Create a rule. Risk: write
Input
Output

deleteRule

rules.deleteRule Gorgias REST: Delete a rule. Risk: destructive
Input
Output: void

getRule

rules.getRule Gorgias REST: Retrieve a rule. Risk: read
Input
Output

listRules

rules.listRules Gorgias REST: List rules. Risk: read
Input
Output

updateRule

rules.updateRule Gorgias REST: Update a rule. Risk: write
Input
Output

updateRulesPriorities

rules.updateRulesPriorities Gorgias REST: Update rules’ priorities. Risk: write
Input
Output: object[]

Satisfaction Surveys

createSatisfactionSurvey

satisfactionSurveys.createSatisfactionSurvey Gorgias REST: Create a survey. Risk: destructive
Input
Output

getSatisfactionSurvey

satisfactionSurveys.getSatisfactionSurvey Gorgias REST: Retrieve a survey. Risk: read
Input
Output

listSatisfactionSurveys

satisfactionSurveys.listSatisfactionSurveys Gorgias REST: List surveys. Risk: read
Input
Output

updateSatisfactionSurvey

satisfactionSurveys.updateSatisfactionSurvey Gorgias REST: Update a survey. Risk: write
Input
Output

search

search.search Gorgias REST: Search for resources. Risk: read
Input
Output: Record<string, JsonValue>

Statistics

downloadLegacyStatistic

statistics.downloadLegacyStatistic Gorgias REST: Download a statistic. Risk: read
Input Returns a { kind: "binary", contentType, base64, sizeBytes } object for the provider CSV response.
Output

getLegacyStatistic

statistics.getLegacyStatistic Gorgias REST: Retrieve a statistic. Risk: read
Input
Output

Tags

createTag

tags.createTag Gorgias REST: Create a tag. Risk: write
Input
Output

deleteTag

tags.deleteTag Gorgias REST: Delete a tag. Risk: destructive
Input
Output: void

deleteTags

tags.deleteTags Gorgias REST: Delete tags. Risk: destructive
Input
Output: void

getTag

tags.getTag Gorgias REST: Retrieve a tag. Risk: read
Input
Output

listTags

tags.listTags Gorgias REST: List tags. Risk: read
Input
Output

mergeTags

tags.mergeTags Gorgias REST: Merge tags. Risk: destructive
Input Merges source tags into the destination tag and deletes the source tags.
Output

updateTag

tags.updateTag Gorgias REST: Update a tag. Risk: write
Input
Output

Teams

createTeam

teams.createTeam Gorgias REST: Create a team. Risk: write
Input
Output

deleteTeam

teams.deleteTeam Gorgias REST: Delete a team. Risk: destructive
Input
Output: void

getTeam

teams.getTeam Gorgias REST: Retrieve a team. Risk: read
Input
Output

listTeams

teams.listTeams Gorgias REST: List teams. Risk: read
Input
Output

updateTeam

teams.updateTeam Gorgias REST: Update a team. Risk: write
Input
Output

Ticket Messages

createTicketMessage

ticketMessages.createTicketMessage Gorgias REST: Create a message. Risk: destructive
Input This operation can send a customer-visible message and is marked destructive. Set query.action and the documented If-Unmodified-Since header when using concurrency control.
Output

deleteTicketMessage

ticketMessages.deleteTicketMessage Gorgias REST: Delete a message. Risk: destructive
Input
Output: void

getTicketMessage

ticketMessages.getTicketMessage Gorgias REST: Retrieve a message. Risk: read
Input
Output

listMessages

ticketMessages.listMessages Gorgias REST: List messages. Risk: read
Input
Output

listTicketMessages

ticketMessages.listTicketMessages Gorgias REST: List messages of a ticket. Risk: read
Input Gorgias marks this route deprecated; use ticketMessages.listMessages with query.ticket_id for new integrations.
Output

updateTicketMessage

ticketMessages.updateTicketMessage Gorgias REST: Update a message. Risk: write
Input
Output

Tickets

createTicket

tickets.createTicket Gorgias REST: Create a ticket. Messages without sent_datetime are sent to the customer by Gorgias. Risk: destructive
Input
Output

createTicketTags

tickets.createTicketTags Gorgias REST: Add ticket tags. Risk: write
Input
Output: void

deleteTicket

tickets.deleteTicket Gorgias REST: Delete a ticket. Risk: destructive
Input
Output: void

deleteTicketCustomField

tickets.deleteTicketCustomField Gorgias REST: Delete ticket field value. Risk: destructive
Input
Output: void

deleteTicketTags

tickets.deleteTicketTags Gorgias REST: Remove ticket tags. Risk: destructive
Input
Output: void

getTicket

tickets.getTicket Gorgias REST: Retrieve a ticket. Risk: read
Input
Output

listTicketCustomFields

tickets.listTicketCustomFields Gorgias REST: List ticket field values. Risk: read
Input
Output

listTickets

tickets.listTickets Gorgias REST: List tickets. Risk: read
Input
Output

listTicketTags

tickets.listTicketTags Gorgias REST: List ticket tags. Risk: read
Input
Output

updateTicket

tickets.updateTicket Gorgias REST: Update a ticket. Risk: write
Input
Output

updateTicketCustomField

tickets.updateTicketCustomField Gorgias REST: Update ticket field value. Risk: write
Input
Output

updateTicketCustomFields

tickets.updateTicketCustomFields Gorgias REST: Replace all custom field values on a ticket. Fields left out of the request are deleted. Risk: destructive
Input This route replaces all custom-field values on the ticket. Include every value you want to retain.
Output

updateTicketTags

tickets.updateTicketTags Gorgias REST: Replace all tags on a ticket with the given list. Risk: destructive
Input
Output: void

Users

createUser

users.createUser Gorgias REST: Create a user. Risk: write
Input
Output

deleteUser

users.deleteUser Gorgias REST: Delete a user. Risk: destructive
Input
Output: void

getUser

users.getUser Gorgias REST: Retrieve a user. Risk: read
Input The route page’s 200 response does not name a schema; the output is validated against Gorgias’s documented User object.
Output

listUsers

users.listUsers Gorgias REST: List users. Risk: read
Input
Output

updateUser

users.updateUser Gorgias REST: Update a user. Risk: write
Input
Output

Views

createView

views.createView Gorgias REST: Create a view. Risk: write
Input
Output

deleteView

views.deleteView Gorgias REST: Delete a view. Risk: destructive
Input
Output: void

getView

views.getView Gorgias REST: Retrieve a view. Risk: read
Input
Output

listViewItems

views.listViewItems Gorgias REST: List view’s items. Risk: read
Input
Output

listViews

views.listViews Gorgias REST: List views. Risk: read
Input
Output

updateView

views.updateView Gorgias REST: Update a view. Risk: write
Input
Output

updateViewItems

views.updateViewItems Gorgias REST: Search for view’s items. Risk: write
Input
Output

Voice Call Events

getVoiceCallEvent

voiceCallEvents.getVoiceCallEvent Gorgias REST: Retrieve a voice call event. Risk: read
Input
Output

listVoiceCallEvents

voiceCallEvents.listVoiceCallEvents Gorgias REST: List voice call events. Risk: read
Input
Output

Voice Call Recordings

deleteVoiceCallRecording

voiceCallRecordings.deleteVoiceCallRecording Gorgias REST: Delete a voice call recording. Risk: destructive
Input
Output: void

getVoiceCallRecording

voiceCallRecordings.getVoiceCallRecording Gorgias REST: Retrieve a voice call recording. Risk: read
Input
Output

listVoiceCallRecordings

voiceCallRecordings.listVoiceCallRecordings Gorgias REST: List voice call recordings. Risk: read
Input
Output

Voice Calls

getVoiceCall

voiceCalls.getVoiceCall Gorgias REST: Retrieve a voice call. Risk: read
Input
Output

listVoiceCalls

voiceCalls.listVoiceCalls Gorgias REST: List voice calls. Risk: read
Input
Output

Widgets

createWidget

widgets.createWidget Gorgias REST: Create a widget. Risk: write
Input
Output

deleteWidget

widgets.deleteWidget Gorgias REST: Delete a widget. Risk: destructive
Input
Output: void

getWidget

widgets.getWidget Gorgias REST: Retrieve a widget. Risk: read
Input
Output

listWidgets

widgets.listWidgets Gorgias REST: List widgets. Risk: read
Input
Output

updateWidget

widgets.updateWidget Gorgias REST: Update a widget. Risk: write
Input
Output