> ## Documentation Index
> Fetch the complete documentation index at: https://nango.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Gorgias Basic Auth

## Overview

> [card] [Pre-built tooling](#pre-built-tooling)

> [card] [Pre-built integrations](#pre-built-integrations)

> [card] [Access requirements](#access-requirements)

> [card] [Setup guide](#setup-guide)

> [card] [Useful links](#useful-links)

> [card] [API gotchas](#api-gotchas)

## Pre-built tooling

> [accordion] ✅ Authorization
>
> | Tools | Status |
> | - | - |
> | Pre-built authorization (Basic) | ✅ |
> | Pre-built authorization UI | ✅ |
> | Custom authorization UI | ✅ |
> | End-user authorization guide | ✅ |
> | Expired credentials detection | ✅ |

> [accordion] ✅ Read & write data
>
> | Tools | Status |
> | - | - |
> | Pre-built integrations | ✅ |
> | API unification | ✅ |
> | 2-way sync | ✅ |
> | Webhooks from Nango on data modifications | ✅ |
> | Real-time webhooks from 3rd-party API | 🚫 (time to contribute: \<48h) |
> | Proxy requests | ✅ |

> [accordion] ✅ Observability & data quality
>
> | Tools | Status |
> | - | - |
> | HTTP request logging | ✅ |
> | End-to-end type safety | ✅ |
> | Data runtime validation | ✅ |
> | OpenTelemetry export | ✅ |
> | Slack alerts on errors | ✅ |
> | Integration status API | ✅ |

> [accordion] ✅ Customization
>
> | Tools | Status |
> | - | - |
> | Create or customize use-cases | ✅ |
> | Pre-configured pagination | 🚫 (time to contribute: \<48h) |
> | Pre-configured rate-limit handling | 🚫 (time to contribute: \<48h) |
> | Per-customer configurations | ✅ |

### Others

| Function name | Description | Type |
| - | - | - |
| `add-ticket-tags` | Add one or more existing tags to a ticket (additive, does not remove existing tags). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `bulk-update-custom-fields` | Bulk update custom field definitions. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `cancel-job` | Cancel a pending/running bulk-operation job | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-custom-field` | Create a custom field definition for tickets or customers. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-customer` | Create a customer with one or more contact channels. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-macro` | Create a macro with one or more actions (e.g. setResponseText). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-rule` | Create an automation rule with JavaScript-like condition/action code. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-satisfaction-survey` | Create a satisfaction survey record for a ticket and customer. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-tag` | Create a tag. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-team` | Create a team. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-ticket-message` | Add a new message to an existing ticket. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-ticket` | Create a ticket, finding or creating the customer by email/phone and choosing the phone vs. email message channel based on account settings. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-user` | Create a new user with a role in Gorgias. Defaults to agent if a role is not provided. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-view` | Create a view (saved filter) for tickets or customers. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-customer-custom-field-value` | Clear a single custom field value on a customer. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-customer` | Delete a customer. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-macro` | Delete a macro | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-rule` | Delete a rule. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-tag` | Delete a tag. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-tags` | Delete multiple tags in one call. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-team` | Delete a team | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-ticket-custom-field-value` | Clear a single custom field value on a ticket | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-ticket-message` | Delete a message from a ticket. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-ticket` | Delete a ticket. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-user` | Delete a user in Gorgias. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-view` | Delete a view. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-account` | Get details about the current Gorgias account. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-custom-field` | Retrieve a single custom field definition. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-customer` | Retrieve a single customer, including their contact channels. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-event` | Retrieve a single event. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-integration` | Retrieve a single integration's configuration. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-job` | Retrieve a single job's status/progress. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-macro` | Retrieve a single macro. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-rule` | Retrieve a single automation rule, including its code and parsed AST. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-satisfaction-survey` | Retrieve a single satisfaction survey. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-stats-overview` | Retrieve a named statistic over a date range. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-tag` | Retrieve a single tag. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-team` | Retrieve a single team. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-ticket-message` | Retrieve a single message on a ticket. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-ticket` | Retrieve a single ticket, including its full messages array. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-user` | Retrieve a single user. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-view` | Retrieve a single view. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-account-settings` | List account-level settings (business hours, ticket assignment, satisfaction survey config, access/SSO, auto-merge, auto-split, default integration, etc.). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-custom-fields` | List custom field definitions for tickets or customers. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-customer-custom-field-values` | List all custom field values set on a customer. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-customers` | List customers, optionally filtered by email, name, external ID, language, timezone, view, or channel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-events` | List account audit-trail events, filterable by object type/ID, event types, user, and creation-date range. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-integrations` | List configured integrations (email senders, HTTP integrations, apps, etc.) on the account. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-jobs` | List bulk-operation jobs (e.g., bulk delete/export), filterable by status and type. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-macros` | List macros (canned response templates), optionally searched, filtered by tags/language/archived state, or ranked by relevance to a ticket/message. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-rules` | List automation rules, optionally searched. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-satisfaction-surveys` | List satisfaction surveys, optionally filtered by ticket. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-tags` | List tags, optionally searched or ordered by usage. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-teams` | List teams. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-ticket-custom-field-values` | List all custom field values set on a ticket. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-ticket-messages` | List messages on a specific ticket | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-ticket-tags` | List tags currently applied to a ticket. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-tickets` | List tickets, optionally filtered by customer, view, rule, or specific IDs. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-users` | List users (agents/admins/bots), optionally filtered by role, email, or search term. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-view-items` | List the tickets or customers matching a view's saved filter. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-views` | List views (saved ticket/customer filter definitions), optionally filtered to system or user-created views. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `merge-customers` | Merge one customer into another, deleting the source customer. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `merge-tags` | Merge one or more source tags into a destination tag. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `remove-ticket-tags` | Remove one or more tags from a ticket. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `search` | Search across agents, customers, customer channels/profiles, integrations, teams, or tags by a text query. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `set-customer-data` | Set arbitrary structured JSON data on a customer data field. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `set-ticket-tags` | Replace a ticket's full tag list with the given set of existing tags. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `unarchive-macros` | Unarchive up to 30 macros in one call. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-custom-field` | Update a custom field definition, or deactivate it. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-customer-custom-field-value` | Set a single custom field value on a customer. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-customer-custom-field-values` | Set multiple custom field values on a customer in one call. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-customer` | Update a customer's fields (name, email, channels, language, timezone, external ID). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-macro` | Update a macro's name, actions, tags, or language. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-rule-priorities` | Reorder the execution priority of multiple rules in one call. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-rule` | Update a rule's name, code, or description. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-satisfaction-survey` | Update a satisfaction survey (e.g. record a customer's score). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-tag` | Rename a tag or change its decoration or description. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-team` | Update a team's name or description. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-ticket-custom-field-value` | Set a single custom field value on a ticket. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-ticket-custom-field-values` | Set multiple custom field values on a ticket in one call. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-ticket-message` | Update a message's fields (e.g. body\_text/body\_html). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-ticket` | Update a ticket's fields (subject, status, priority, assignee, tags, channel, custom fields, etc.). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-user` | Update a user's fields (name, email, role, bio, etc.). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-view` | Update a view's fields. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `custom-fields` | Sync custom field definitions for both tickets and customers | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `customers` | Sync customers and their contact channels. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `events` | Sync the account's audit-trail events (ticket/customer/user/tag/rule/etc. lifecycle events). | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `integrations` | Sync configured integrations (email senders, HTTP integrations, apps, etc.) | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `macros` | Sync macros (canned response templates). | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `rules` | Sync automation rules. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `satisfaction-surveys` | Sync satisfaction surveys. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `tags` | Sync tags. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `teams` | Sync teams. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `ticket-messages` | Sync messages across all tickets. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `tickets` | Sync tickets with their full messages. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `users` | Sync users (agents/admins/bots). | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `views` | Sync views (saved ticket/customer filter definitions), including built-in system views. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |

## Access requirements

| Pre-Requisites | Status | Comment |
| - | - | - |
| Paid dev account | ❓ | |
| Paid test account | ❓ | |
| Partnership | ❓ | |
| App review | ❓ | |
| Security audit | ❓ | |

## Setup guide

*No setup guide yet.*

> [!TIP]
>
> Need help getting started? Get help in the [community](https://nango.dev/slack).

> [!NOTE]
>
> Contribute improvements to the setup guide by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/gorgias.mdx)

## Useful links

* [Basic Auth docs](https://developers.gorgias.com/docs/access-tokens-api-keys)

> [!NOTE]
>
> Contribute useful links by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/gorgias-basic.mdx)

## API gotchas

> [!NOTE]
>
> Contribute API gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/gorgias.mdx)

> [card] [Connect to Gorgias Basic Auth](https://nango.dev/docs/integrations/all/gorgias-basic/connect)
>
> Guide to connect to Gorgias Basic Auth using Nango Connect.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.