CINXE.COM
gorgias-developers
<!DOCTYPE html><html lang="en" style="" data-color-mode="system" class=" useReactApp "><head><meta charset="utf-8"><meta name="readme-deploy" content="5.323.0"><meta name="readme-subdomain" content="gorgias-developers"><meta name="readme-version" content="1.0"><title>gorgias-developers</title><meta name="description"><meta property="og:title" content="gorgias-developers"><meta property="og:description"><meta property="og:site_name" content="gorgias-developers"><meta name="twitter:title" content="gorgias-developers"><meta name="twitter:description"><meta name="twitter:card" content="summary_large_image"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta property="og:image" content="https://files.readme.io/e509c23-5e693ac1927efe8a51c9662b_logo-gorgias.svg"><meta name="twitter:image" content="https://files.readme.io/e509c23-5e693ac1927efe8a51c9662b_logo-gorgias.svg"><link id="favicon" rel="shortcut icon" href="https://files.readme.io/e0504de-small-blue_logo.png" type="image/png"><link rel="canonical" href="https://developers.gorgias.com/"><script src="https://cdn.readme.io/public/js/cash-dom.min.js?1744040341450"></script><link data-chunk="New" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/New.b2c21b39a87b5c42c152.css"> <link data-chunk="SuperHub-CustomPage" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/SuperHub-CustomPage.6f815c83f54659ae791f.css"> <link data-chunk="CustomPage" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="List" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/List.0b0b64406047e2a3670a.css"> <link data-chunk="routes-Tutorials" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.7e7736cc7c5b0affc361.css"> <link data-chunk="Page" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Page.b2c21b39a87b5c42c152.css"> <link data-chunk="routes-Discuss" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Discuss.b6e3c66bfa4e65097f5f.css"> <link data-chunk="routes-Changelog" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Changelog.28957affcff81e852361.css"> <link data-chunk="Editor" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Editor.23606d783f007047768a.css"> <link data-chunk="routes-Landing" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Landing.332d7eed7b2d976c458e.css"> <link data-chunk="routes-PageNotFound" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.d8afd1171cf7a455eed7.css"> <link data-chunk="routes-Reference" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Reference.883d037c9b5898d42a5d.css"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.59e02500db2c520b4509.css"> <link data-chunk="Footer" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Footer.7ca87f1efe735da787ba.css"> <link data-chunk="routes-Doc" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Doc.0ab6d6e327e2be33020a.css"> <link data-chunk="Header" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Header.4c8c34bca506869e518a.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.7e7ac3b831d39ed8ef99.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/7188.75e3fc491ee8103c63a3.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/2395.593cd7b6ba0bdb6787a8.css"> <link data-chunk="main" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/main.4c43266695a6f2b7b2bf.css"> <link data-chunk="main" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/ui-styles.71f3759193a773853a84.css"> <link data-chunk="main" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/main.871db54d053c293b178f.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6601.cef2fa12a9b5e2b9df03.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1126.9d43ffa1039df16a8271.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6563.fbd3d15eee3b5e94f665.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9772.89a3e895d3051e33cd73.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4904.1067704c85da57778e22.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7449.dae0332305a8704415a6.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7372.fbd27ab77e6e47de9931.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/187.23cea47109f7f88417f6.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/734.2949e3d7010fa5c21ffd.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/954.53ce7f86793664155f78.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1167.a6c63c62c8690225da20.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2395.771431a607874f268eb2.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9321.7bab74274e71e18bb347.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/3073.ef6aff2d0ae6023765f1.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1008.c5d3d5f6718d217517a6.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7188.f444adf64944d115c52b.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/5753.72c5d7402efc1cfa5881.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.3432b44653552d31effc.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2249.08687f22f6d6de29577d.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/3901.9a23139e8c32bd6a1186.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7783.54e7cbd61e710313e1e0.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Header.415a3e3f42422a2546f5.js"> <link data-chunk="core-icons-chevron-up-down-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-chevron-up-down-svg.6aae957df71e6f4c5e24.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4287.916cdd386055d2c5d238.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4201.9726bbf672400e046cc2.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Doc.ab23d1cf8ea817ed6084.js"> <link data-chunk="Footer" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Footer.732d39065ba473dca3be.js"> <link data-chunk="core-icons-search-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-search-svg.ad9cac962958d30983a7.js"> <link data-chunk="core-icons-custom-pages-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-custom-pages-svg.444e514638d9afbec182.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7717.c3f46aef4dac129abcfb.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/5359.fb0c48929b1827a8a2b2.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/5948.a51402657e2eb40ab43b.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/8230.776279fe7bfd3c0ffd09.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.4630fef2d52dd3c2b8ff.js"> <link data-chunk="core-icons-more-vertical-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-more-vertical-svg.4822b3f831e11095980d.js"> <link data-chunk="core-icons-lock-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-lock-svg.70942d3ee6bad6267696.js"> <link data-chunk="RMDX" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/RMDX.6966846032c03969e44f.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Reference.a6b1c6bee69d46fd161f.js"> <link data-chunk="core-icons-webhook-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-webhook-svg.fe540ea1c09e1c0e0247.js"> <link data-chunk="routes-PageNotFound" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.e4a4a4dbb41ce1f8c60f.js"> <link data-chunk="routes-Landing" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/3906.b84848dda7e7f59abf47.js"> <link data-chunk="routes-Landing" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Landing.43a15229736801911d5a.js"> <link data-chunk="Editor" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Editor.fcff689c44b953a512d6.js"> <link data-chunk="core-icons-x-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-x-circle-svg.abc0e0ea5b7f9dff667c.js"> <link data-chunk="core-icons-suggested-edits-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-suggested-edits-svg.8d2d8ac2fd22ded9238d.js"> <link data-chunk="core-icons-alert-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-alert-circle-svg.4cee8264c97045599b56.js"> <link data-chunk="core-icons-arrow-right-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-arrow-right-svg.eadb74658f93b4e7d75f.js"> <link data-chunk="routes-Changelog" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Changelog.05be16260f5ffacc35a3.js"> <link data-chunk="Post" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Post.0ba0ba3778e78d8254e8.js"> <link data-chunk="routes-Discuss" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Discuss.9a682a77c9083927aeaf.js"> <link data-chunk="Page" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2637.d47bf77a75f266a70e80.js"> <link data-chunk="Page" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Page.6d18db72aa3774dd903a.js"> <link data-chunk="core-icons-chevron-down-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-chevron-down-svg.e20b84e9871bd73d1b8c.js"> <link data-chunk="routes-Tutorials" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.c83f9bb228d60f5f7f6b.js"> <link data-chunk="List" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/List.b1dd4485529aa4a7aa11.js"> <link data-chunk="CustomPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/CustomPage.29543915f3e70fa960d7.js"> <link data-chunk="core-icons-arrow-up-right-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-arrow-up-right-svg.8ec73f7e322d79a2695b.js"> <link data-chunk="core-icons-eye-off-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-eye-off-svg.b2b8b241b4b324dfd9c1.js"> <link data-chunk="core-icons-chevron-right-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-chevron-right-svg.34d126524d8ea236d174.js"> <link data-chunk="core-icons-plus-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-plus-svg.a49fb76ac2661b5e1c7e.js"> <link data-chunk="core-icons-folder-plus-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-folder-plus-svg.2c200438e59611867262.js"> <link data-chunk="core-icons-file-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-file-svg.24d3e20044ef331cf0d2.js"> <link data-chunk="core-icons-eye-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-eye-svg.b2103692a3c209893efe.js"> <link data-chunk="SuperHub-CustomPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/SuperHub-CustomPage.edef7b501475b233c5a2.js"> <link data-chunk="core-icons-book-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-book-svg.556c5a2abddd44b2284c.js"> <link data-chunk="core-icons-key-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-key-svg.71e09670b926900508b8.js"> <link data-chunk="core-icons-gauge-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-gauge-circle-svg.fff25782546fef314a09.js"> <link data-chunk="core-icons-star-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-star-svg.b834e1612cb2af1e174e.js"> <link data-chunk="core-icons-trending-up-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-trending-up-svg.0dd920b0698e57f75afa.js"> <link data-chunk="core-icons-callout-info-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-callout-info-svg.79b14e8568c9cecbc827.js"> <link data-chunk="core-icons-message-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-message-circle-svg.1e24c2d2eb4f9a6ede5d.js"> <link data-chunk="New" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/New.19db37c76f3b9d17353d.js"> <link data-chunk="main" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/ui-styles.71f3759193a773853a84.css"> <link data-chunk="main" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/main.4c43266695a6f2b7b2bf.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/2395.593cd7b6ba0bdb6787a8.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/7188.75e3fc491ee8103c63a3.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.7e7ac3b831d39ed8ef99.css"> <link data-chunk="Header" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Header.4c8c34bca506869e518a.css"> <link data-chunk="routes-Doc" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Doc.0ab6d6e327e2be33020a.css"> <link data-chunk="Footer" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Footer.7ca87f1efe735da787ba.css"> <link data-chunk="routes-SuperHub-Routes" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.59e02500db2c520b4509.css"> <link data-chunk="routes-Reference" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Reference.883d037c9b5898d42a5d.css"> <link data-chunk="routes-PageNotFound" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.d8afd1171cf7a455eed7.css"> <link data-chunk="routes-Landing" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Landing.332d7eed7b2d976c458e.css"> <link data-chunk="Editor" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Editor.23606d783f007047768a.css"> <link data-chunk="routes-Changelog" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Changelog.28957affcff81e852361.css"> <link data-chunk="routes-Discuss" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Discuss.b6e3c66bfa4e65097f5f.css"> <link data-chunk="Page" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Page.b2c21b39a87b5c42c152.css"> <link data-chunk="routes-Tutorials" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.7e7736cc7c5b0affc361.css"> <link data-chunk="List" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/List.0b0b64406047e2a3670a.css"> <link data-chunk="CustomPage" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="SuperHub-CustomPage" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/SuperHub-CustomPage.6f815c83f54659ae791f.css"> <link data-chunk="New" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/New.b2c21b39a87b5c42c152.css"><!-- CUSTOM CSS--><style title="rm-custom-css">:root{--project-color-primary:#242F8C;--project-color-inverse:#fff;--recipe-button-color:#0075FF;--recipe-button-color-hover:#004699;--recipe-button-color-active:#002f66;--recipe-button-color-focus:rgba(0, 117, 255, 0.25);--recipe-button-color-disabled:#cce3ff}[id=enterprise] .ReadMeUI[is=AlgoliaSearch]{--project-color-primary:#242F8C;--project-color-inverse:#fff}a{color:var(--color-link-primary,#0075ff)}a:hover{color:var(--color-link-primary-darken-5,#004699)}a.text-muted:hover{color:var(--color-link-primary,#0075ff)}.btn.btn-primary{background-color:#0075ff}.btn.btn-primary:hover{background-color:#004699}.theme-line #hub-landing-top h2{color:#0075ff}#hub-landing-top .btn:hover{color:#0075ff}.theme-line #hub-landing-top .btn:hover{color:#fff}.theme-solid header#hub-header #header-top{background-color:#242f8c}.theme-solid.header-gradient header#hub-header #header-top{background:linear-gradient(to bottom,#242f8c,#0d1557)}.theme-solid.header-custom header#hub-header #header-top{background-image:url(https://files.readme.io/14e37b9-hero.png)}.theme-line header#hub-header #header-top{border-bottom-color:#242f8c}.theme-line header#hub-header #header-top .btn{background-color:#242f8c}header#hub-header #header-top #header-logo{width:168px;height:40px;margin-top:0;background-image:url(https://files.readme.io/d4ae1cd-gorgias_dark.svg)}#hub-subheader-parent #hub-subheader .hub-subheader-breadcrumbs .dropdown-menu a:hover{background-color:#242f8c}#subheader-links a.active{color:#242f8c!important;box-shadow:inset 0 -2px 0 #242f8c}#subheader-links a:hover{color:#242f8c!important;box-shadow:inset 0 -2px 0 #242f8c;opacity:.7}.discussion .submit-vote.submit-vote-parent.voted a.submit-vote-button{background-color:#0075ff}section#hub-discuss .discussion a .discuss-body h4{color:#0075ff}section#hub-discuss .discussion a:hover .discuss-body h4{color:#004699}#hub-subheader-parent #hub-subheader.sticky-header.sticky{border-bottom-color:#0075ff}#hub-subheader-parent #hub-subheader.sticky-header.sticky .search-box{border-bottom-color:#0075ff}#hub-search-results h3 em{color:#0075ff}.main_background,.tag-item{background:#0075ff!important}.main_background:hover{background:#004699!important}.main_color{color:#242f8c!important}.border_bottom_main_color{border-bottom:2px solid #242f8c}.main_color_hover:hover{color:#242f8c!important}section#hub-discuss h1{color:#0075ff}#hub-reference .hub-api .api-definition .api-try-it-out.active{border-color:#0075ff;background-color:#0075ff}#hub-reference .hub-api .api-definition .api-try-it-out.active:hover{background-color:#004699;border-color:#004699}#hub-reference .hub-api .api-definition .api-try-it-out:hover{border-color:#0075ff;color:#0075ff}#hub-reference .hub-reference .logs .logs-empty .logs-login-button,#hub-reference .hub-reference .logs .logs-login .logs-login-button{background-color:var(--project-color-primary,#0075ff);border-color:var(--project-color-primary,#0075ff)}#hub-reference .hub-reference .logs .logs-empty .logs-login-button:hover,#hub-reference .hub-reference .logs .logs-login .logs-login-button:hover{background-color:#004699;border-color:#004699}#hub-reference .hub-reference .logs .logs-empty>svg>path,#hub-reference .hub-reference .logs .logs-login>svg>path{fill:#0075ff;fill:var(--project-color-primary,#0075ff)}#hub-reference .hub-reference .logs:last-child .logs-empty,#hub-reference .hub-reference .logs:last-child .logs-login{margin-bottom:35px}#hub-reference .hub-reference .hub-reference-section .hub-reference-left header .hub-reference-edit:hover{color:#0075ff}.main-color-accent{border-bottom:3px solid #242f8c;padding-bottom:8px}/*! BEGIN HUB_CUSTOM_STYLES */.hub-reference-response-definitions{display:none!important}.react-json-view{font-family:Monaco,lucida console,monospace!important;padding:0!important;letter-spacing:0!important}.react-json-view .variable-row{padding-top:0!important;padding-bottom:0!important}.react-json-view .object-key{color:#e8e8e8!important;letter-spacing:inherit!important}.react-json-view .variable-value>div{color:#dd925f!important}.react-json-view .collapsed-icon>svg,.react-json-view .expanded-icon>svg{color:#6c8eef!important}.react-json-view .array-key{color:#d7a3ff!important}.react-json-view .string-value{color:#b5bc67!important}.react-json-view .node-ellipsis{font-size:inherit!important}/*! END HUB_CUSTOM_STYLES */</style><meta name="loadedProject" content="gorgias-developers"><script>var storedColorMode = `system` === 'system' ? window.localStorage.getItem('color-scheme') : `system` document.querySelector('[data-color-mode]').setAttribute('data-color-mode', storedColorMode)</script><script id="config" type="application/json" data-json="{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"dc8065a65ef83d6ad23e37aaf014fc84","enabled":true},"asset_url":"https://cdn.readme.io","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2025-03-27","fullstory":{"enabled":true,"orgId":"FSV9A"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.323.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true,"tracesSampleRate":0},"shMigration":{"promoVideo":"","forceWaitlist":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}}"></script></head><body class="body-none theme-solid header-custom header-bg-size-cover header-bg-pos-tc header-overlay-triangles reference-layout-column lumosity-normal no-sidebar hub-is-home"><div id="ssr-top"></div><div id="ssr-main"><div class="App ThemeContext ThemeContext_dark " style="--color-primary:#242F8C;--color-primary-inverse:#fff;--color-primary-alt:#0d1557;--color-primary-darken-10:#1a2163;--color-primary-darken-20:#0f143b;--color-primary-alpha-25:rgba(36, 47, 140, 0.25);--color-link-primary:#0075FF;--color-link-primary-darken-5:#0069e6;--color-link-primary-darken-10:#005ecc;--color-link-primary-darken-20:#004699;--color-link-primary-alpha-50:rgba(0, 117, 255, 0.5);--color-link-primary-alpha-25:rgba(0, 117, 255, 0.25);--color-link-background:rgba(0, 117, 255, 0.09);--color-link-text:#fff;--color-login-link:#018ef5;--color-login-link-text:#fff;--color-login-link-darken-10:#0171c2;--color-login-link-primary-alpha-50:rgba(1, 142, 245, 0.5)"><header class="Header3zzata9F_ZPQ rm-Header rm-Header_overlay rm-Header_overlay-custom rm-Header_custom rm-Header_custom-pos-top-center rm-Header_custom-size-cover" style="background-image:url(https://files.readme.io/14e37b9-hero.png)"><div class="rm-Header-top Header-topuTMpygDG4e1V"><div class="rm-Container rm-Container_flex"><div style="outline:none" tabindex="-1"><a href="#content" target="_self" class="Button Button_md rm-JumpTo Header-jumpTo3IWKQXmhSI5D Button_primary">Jump to Content</a></div><div class="rm-Header-left Header-leftADQdGVqx1wqU"><a class="rm-Logo Header-logo1Xy41PtkzbdG" href="/" target="_self"><img alt="gorgias-developers" class="rm-Logo-img Header-logo-img3YvV4lcGKkeb" src="https://files.readme.io/d4ae1cd-gorgias_dark.svg"/></a></div><div class="rm-Header-left Header-leftADQdGVqx1wqU Header-left_mobile1RG-X93lx6PF"><div><button aria-label="Toggle navigation menu" class="icon-menu menu3d6DYNDa3tk5" type="button"></button><div class=""><div class="Flyout95xhYIIoTKtc undefined rm-Flyout" data-testid="flyout"><div class="MobileFlyout1hHJpUd-nYkd"><a aria-current="page" class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- active" href="/" target="_self"><i class="icon-landing-page-2 NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Home</span></a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/docs" target="_self"><i class="icon-guides NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Quickstart</span></a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/reference" target="_self"><i class="icon-references NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">API Reference</span></a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/changelog" target="_self"><i class="icon-changelog NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Changelog</span></a><hr class="MobileFlyout-divider10xf7R2X1MeW"/><a class="MobileFlyout-logo3Lq1eTlk1K76 Header-logo1Xy41PtkzbdG rm-Logo" href="/" target="_self"><img alt="gorgias-developers" class="Header-logo-img3YvV4lcGKkeb rm-Logo-img" src="https://files.readme.io/d4ae1cd-gorgias_dark.svg"/></a></div></div></div></div><div class="Header-left-nav2xWPWMNHOGf_"><i class="icon-landing-page-2 Header-left-nav-icon10glJKFwewOv"></i>Home</div></div><div class="rm-Header-right Header-right21PC2XTT6aMg"><span class="Header-right_desktop14ja01RUQ7HE"></span><div class="ThemeToggle-wrapper1M_iJESXCpGR Dropdown Dropdown_closed"><button aria-label="Toggle to light mode" id="ThemeToggle-button-static-id-placeholder" aria-haspopup="dialog" class="Button Button_slate_text Button_sm rm-ThemeToggle ThemeToggle2tVPbUyQbWDo Dropdown-toggle Button_primary" type="button"><svg aria-labelledby="ThemeToggle-button-static-id-placeholder" class="Icon ThemeToggle-Icon3g9ZT7pRMwCv " role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Moon (Dark Mode)</title><path d="M19 14.79C18.8427 16.4922 18.2039 18.1144 17.1582 19.4668C16.1126 20.8192 14.7035 21.8458 13.0957 22.4265C11.4879 23.0073 9.74798 23.1181 8.0795 22.7461C6.41102 22.3741 4.88299 21.5345 3.67423 20.3258C2.46546 19.117 1.62594 17.589 1.25391 15.9205C0.881876 14.252 0.992717 12.5121 1.57346 10.9043C2.1542 9.29651 3.18083 7.88737 4.53321 6.84175C5.8856 5.79614 7.5078 5.15731 9.21 5C8.21341 6.34827 7.73385 8.00945 7.85853 9.68141C7.98322 11.3534 8.70386 12.9251 9.8894 14.1106C11.0749 15.2961 12.6466 16.0168 14.3186 16.1415C15.9906 16.2662 17.6517 15.7866 19 14.79Z"></path><path class="ThemeToggle-Icon-star3wweJby1gM4w" d="M18.3707 1C18.3707 3.22825 16.2282 5.37069 14 5.37069C16.2282 5.37069 18.3707 7.51313 18.3707 9.74138C18.3707 7.51313 20.5132 5.37069 22.7414 5.37069C20.5132 5.37069 18.3707 3.22825 18.3707 1Z"></path></svg><svg aria-labelledby="ThemeToggle-button-static-id-placeholder" class="Icon ThemeToggle-Icon3g9ZT7pRMwCv ThemeToggle-Icon_active18I2-19CkbgD" role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Sun (Light Mode)</title><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M12 1V3"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M18.36 5.64L19.78 4.22"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M21 12H23"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M18.36 18.36L19.78 19.78"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M12 21V23"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M4.22 19.78L5.64 18.36"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M1 12H3"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M4.22 4.22L5.64 5.64"></path><path d="M12 17C14.7614 17 17 14.7614 17 12C17 9.23858 14.7614 7 12 7C9.23858 7 7 9.23858 7 12C7 14.7614 9.23858 17 12 17Z"></path></svg></button></div><div class="Header-searchtb6Foi0-D9Vx"><button aria-label="Search ⌘k" class="rm-SearchToggle" data-symbol="⌘"><div class="rm-SearchToggle-icon icon-search1"></div></button></div></div></div><div class="undefined container"><div><div class="undefined container"><section class="LandingPageHeader20SNhBZ58Jy5 rm-LandingPageHeader"><h1 class="LandingPageHeader-title16RMwPkp2O2W">Developer Documentation</h1><div class="markdown-body LandingPageHeader-text3zJOEVqnHdlf" data-testid="RDMD"><p>Explore our guides and technical documentation to integrate with Gorgias.</p></div><div align="center" justify="start" layout="row" tag="div" class="Flex Flex_row " style="--flex-gap:var(--md)"><a class="Button Button_md LandingPageHeader-button_primaryLpo1zn3KXh20" href="https://partners.gorgias.com/login" target="_blank"><i class="icon- "></i><span>Start Building</span></a><a class="Button Button_md LandingPageHeader-button_secondary3s2XpkqwCz8B" href="https://www.gorgias.com/apps" target="_blank"><i class="icon-app-store"></i><span>Visit App Store</span></a></div></section></div></div></div></div><div class="Header-bottom2eLKOFXMEmh5 rm-Header-bottom "><div class="rm-Container rm-Container_flex"><nav aria-label="Primary navigation" class="Header-leftADQdGVqx1wqU" role="navigation"><a aria-current="page" class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile active" href="/" target="_self"><i class="icon-landing-page-2"></i><span>Home</span></a><a class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile " href="/docs" target="_self"><i class="icon-guides"></i><span>Quickstart</span></a><a class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile " href="/reference" target="_self"><i class="icon-references"></i><span>API Reference</span></a><a class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile " href="/changelog" target="_self"><i class="icon-changelog"></i><span>Changelog</span></a></nav><div class="rm-Header-search Header-searchtb6Foi0-D9Vx "><button aria-label="Search ⌘k" class="rm-SearchToggle" data-symbol="⌘"><div class="rm-SearchToggle-icon icon-search1"></div><div class="Header-search-placeholder3Vx4OmMPcjAi rm-SearchToggle-placeholder">Search</div><div class="rm-SearchToggle-shortcut"></div></button></div></div></div><div class="hub-search-results--reactApp " id="hub-search-results"><div class="hub-container"><div class="modal-backdrop show-modal rm-SearchModal" role="button" tabindex="0"></div></div></div></header><main class="LandingWrap16kRMSdr5J8g rm-LandingPage" id="content"><div class="LandingBlock3PM-HyBxby3X LandingBlock_align=leftG1r7ROyW_AGB"><div class="rm-Markdown markdown-body" data-testid="RDMD"><h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="start-building-on-gorgias-today"></div><div class="heading-text"><div id="section-start-building-on-gorgias-today" class="heading-anchor_backwardsCompatibility"></div>Start Building on Gorgias Today</div><a aria-label="Skip link to Start Building on Gorgias Today" class="heading-anchor-icon fa fa-anchor" href="#start-building-on-gorgias-today"></a></h2> <p>Integrate with Gorgias to support thousands of shop owners and grow your app audience. Or simply build a private app to empower your support team with the tools they need. Regardless of your end goal, follow these easy steps below to build an integration with us.</p></div></div><div class="rm-Markdown markdown-body LandingBlock3PM-HyBxby3X LandingBlock_align=leftG1r7ROyW_AGB" data-testid="RDMD"><div class="rdmd-html"><div class="LandingBlock3PM-HyBxby3X LandingBlock-Three2lm6yBrv1MlV LandingBlock_align=leftG1r7ROyW_AGB"><div class="LandingBlock3PM-HyBxby3X"><div class="markdown-body" data-testid="RDMD"><h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="-join-developer-portal"></div><div class="heading-text"><div id="section-🤖-join-developer-portal" class="heading-anchor_backwardsCompatibility"></div>🤖 1. Join Developer Portal</div><a aria-label="Skip link to 🤖 Join Developer Portal" class="heading-anchor-icon fa fa-anchor" href="#-join-developer-portal"></a></h2> <p>Sign up for our <a href="https://partners.gorgias.com/signup" target="_blank">Developer Portal</a> to start our partnership. This step is required only if you plan to build a Public app.</p></div></div><div class="LandingBlock3PM-HyBxby3X"><div class="markdown-body" data-testid="RDMD"><h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="-build-your-app"></div><div class="heading-text"><div id="section-🚧-build-your-app" class="heading-anchor_backwardsCompatibility"></div>🚧 2. Build your app</div><a aria-label="Skip link to 🚧 Build your app" class="heading-anchor-icon fa fa-anchor" href="#-build-your-app"></a></h2> <p>Refer to our <a href="https://developers.gorgias.com/reference/introduction" target="_blank">API documentation</a> to find all the information you need.</p></div></div><div class="LandingBlock3PM-HyBxby3X"><div class="markdown-body" data-testid="RDMD"><h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="-submit-your-app"></div><div class="heading-text"><div id="section-🚀-submit-your-app" class="heading-anchor_backwardsCompatibility"></div>🚀 3. Submit your app</div><a aria-label="Skip link to 🚀 Submit your app" class="heading-anchor-icon fa fa-anchor" href="#-submit-your-app"></a></h2> <p>We'll review it and let you know once it's approved and ready to be published in <a href="https://www.gorgias.com/apps" target="_blank">our App Store</a>. For Private apps there is no need for approval. Go ahead and use it!</p></div></div></div></div></div><div class="rm-Markdown markdown-body LandingBlock3PM-HyBxby3X LandingBlock_align=leftG1r7ROyW_AGB" data-testid="RDMD"><div class="rdmd-html"><div class="markdown-body" data-testid="RDMD"><h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="start-building-on-gorgias-today"></div><div class="heading-text"><div id="section-start-building-on-gorgias-today" class="heading-anchor_backwardsCompatibility"></div>🗞 Sign up for Developer Newsletter</div><a aria-label="Developer Newsletter" class="heading-anchor-icon fa fa-anchor" href="#developer-newsletter"></a></h2> <p>Sign up for our monthly developer newsletter. <br>It contains important updates about upcoming and breaking changes to the API.</p> <button data-tf-popup="aYWisghU" data-tf-size="50" data-tf-iframe-props="title=DevRel - Newsletter signup" data-tf-medium="snippet" style="all:unset;font-family:Helvetica,Arial,sans-serif;display:inline-block;max-width:100%;white-space:nowrap;overflow:hidden;text-overflow:ellipsis;background-color:#0075FF;color:#FFFFFF;font-size:14px;border-radius:4px;padding:0 23px;font-weight:bold;height:35px;cursor:pointer;line-height:35px;text-align:center;margin:0;text-decoration:none;">Sign Up</button></div></div></div></main><footer aria-label="Status banner" class="Footer2U8XAPoGhlgO AppFooter rm-Banners"></footer><div class="ModalWrapper" id="ChatGPT-modal"></div></div></div><div class="ng-non-bindable"><script id="ssr-props" data-initial-props="{"sidebars":{"docs":[{"_id":"60b8f7a0c9b1e80079f6c135","title":"Introduction","slug":"introduction","order":2,"reference":false,"isAPI":false,"project":"5ecd911e605d8a005f87ad63","version":"5ecd911e605d8a005f87ad69","createdAt":"2021-06-03T15:39:12.827Z","__v":0,"pages":[{"_id":"6269c0109d3d22017b5f14ad","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Private vs. Public App","type":"basic","slug":"private-vs-public-app","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-04-27T22:13:36.447Z","category":"60b8f7a0c9b1e80079f6c135","parentDoc":null,"isBodyEmpty":false,"children":[]}]},{"_id":"5f29ed62afdb6902b28ece17","title":"Authentication","slug":"why-build-on-gorgias","order":3,"reference":false,"isAPI":false,"project":"5ecd911e605d8a005f87ad63","version":"5ecd911e605d8a005f87ad69","createdAt":"2020-08-04T23:21:06.987Z","__v":0,"pages":[{"_id":"6269c116021223005924e0b8","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Access Tokens (API Keys)","type":"basic","slug":"access-tokens-api-keys","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-04-27T22:17:58.555Z","category":"5f29ed62afdb6902b28ece17","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"6269c21812cbdb02fa1fa9a9","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"OAuth2 Bearer Token","type":"basic","slug":"oauth2-bearer-token","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-04-27T22:22:16.500Z","category":"5f29ed62afdb6902b28ece17","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"60ad5dab0327a20071bbeedb","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"OAuth2 Scopes","type":"basic","slug":"oauth2-scopes","order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-05-25T20:27:23.397Z","parentDoc":null,"category":"5f29ed62afdb6902b28ece17","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"6269c2f024af7a0170a822d4","title":"Building a Public App","slug":"building-public-app","order":4,"reference":false,"project":"5ecd911e605d8a005f87ad63","version":"5ecd911e605d8a005f87ad69","createdAt":"2022-04-27T22:25:52.510Z","__v":0,"pages":[{"_id":"6269c32079a10c00455505d7","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Overview","type":"basic","slug":"overview","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-04-27T22:26:40.921Z","category":"6269c2f024af7a0170a822d4","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"634754987200c807a4e9b4d3","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Building a high-quality Gorgias app","icon":"","type":"basic","slug":"building-a-high-quality-gorgias-app","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-10-12T23:58:16.933Z","category":"6269c2f024af7a0170a822d4","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"6269c36f148f2b002e7c7c9a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"1. Register on Developer Portal & Get Gorgias Sandbox Account","type":"basic","slug":"1-register-on-developer-portal","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-04-27T22:27:59.745Z","category":"6269c2f024af7a0170a822d4","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"6269c3c73352e500660b9397","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"2. Create a Draft App submission form","type":"basic","slug":"2-create-a-draft-app-submission-form","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-04-27T22:29:27.923Z","category":"6269c2f024af7a0170a822d4","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"609a93b4c9a828001631ef8a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"3. Set up OAuth2","type":"basic","slug":"set-up-oauth2-app-store","order":4,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-05-11T14:24:52.431Z","category":"6269c2f024af7a0170a822d4","parentDoc":null,"deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"6269c603a87796016374ff22","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"4. Build and test your app","type":"basic","slug":"4-build-and-test-your-app","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-04-27T22:38:59.931Z","category":"6269c2f024af7a0170a822d4","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"6269c618e6f97d006b7c5522","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"5. Submit app for review","type":"basic","slug":"5-submit-app-for-review","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-04-27T22:39:20.596Z","category":"6269c2f024af7a0170a822d4","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"6269c64b1fa61300205aa772","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"6. Stay in touch","type":"basic","slug":"6-stay-in-touch","order":7,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-04-27T22:40:11.861Z","category":"6269c2f024af7a0170a822d4","parentDoc":null,"isBodyEmpty":false,"children":[]}]},{"_id":"5f29ed6a99626a0025d8919b","title":"Tutorials","slug":"common-api-use-cases","order":5,"reference":false,"isAPI":false,"project":"5ecd911e605d8a005f87ad63","version":"5ecd911e605d8a005f87ad69","createdAt":"2020-08-04T23:21:14.091Z","__v":0,"pages":[{"_id":"63a591875c992f000fb2f8a6","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"OAuth2 authentication for creating apps with Gorgias","icon":"","type":"basic","slug":"oauth2-authentication-for-creating-apps-with-gorgias","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f29ed6a99626a0025d8919b","createdAt":"2022-12-23T11:31:19.848Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"63a4858756386000a7f9f3f1","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Create a ticket using API","icon":"","type":"basic","slug":"create-a-ticket-using-api","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f29ed6a99626a0025d8919b","createdAt":"2022-12-22T16:27:51.937Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"63a96f2bb4a3910017939850","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Create a new message in ticket via API","icon":"","type":"basic","slug":"create-a-new-message-in-ticket-via-api","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f29ed6a99626a0025d8919b","createdAt":"2022-12-26T09:53:47.314Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5f29ee6e6cf244030db10bf4","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Integrate with a new channel","type":"basic","slug":"receive-and-respond-to-tickets-from-a-third-party-app","order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2020-08-04T23:25:34.756Z","category":"5f29ed6a99626a0025d8919b","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"6001c9dd08dfc60081988090","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Create integrations and widgets","type":"basic","slug":"create-integrations-and-widgets-programmatically","order":4,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-integrations-and-widgets","createdAt":"2021-01-15T16:59:09.422Z","category":"5f29ed6a99626a0025d8919b","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"5f29ee3dd1026902dc1eee27","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Show 3rd-party data in tickets","type":"basic","slug":"display-third-party-data-within-tickets","order":5,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2020-08-04T23:24:45.093Z","category":"5f29ed6a99626a0025d8919b","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"63a59c126d754c0016608392","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Sync Gorgias data with a database","icon":"","type":"basic","slug":"sync-gorgias-data-with-a-database","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f29ed6a99626a0025d8919b","createdAt":"2022-12-23T12:16:18.334Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"6453af3402109402132c4480","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"How to attach Gorgias tracking data to Shopify Cart and Checkout attributes","icon":"","type":"basic","slug":"how-to-attach-gorgias-tracking-data-to-shopify-cart-and-checkout-attributes","order":9,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"enrich-shopify-cart-and-checkout-attributes-with-gorgias-data","category":"5f29ed6a99626a0025d8919b","createdAt":"2023-05-04T13:12:20.250Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"671a4c75b20811001097fa09","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Refresh Shopify Cart’s UI on Updates via Convert","icon":"","type":"basic","slug":"how-to-attach-gorgias-tracking-data-to-shopify-cart-and-checkout-attributes-copy","order":9,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":null,"category":"5f29ed6a99626a0025d8919b","createdAt":"2024-10-24T13:32:37.148Z","isBodyEmpty":false,"children":[]}]}],"refs":[{"_id":"5ed892b261e0040028e64a2f","title":"Gorgias API","slug":"core-resources","order":0,"reference":true,"isAPI":false,"project":"5ecd911e605d8a005f87ad63","version":"5ecd911e605d8a005f87ad69","createdAt":"2020-06-04T06:20:34.688Z","__v":0,"pages":[{"_id":"5f21c18cf292510868eb3139","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Introduction","type":"basic","slug":"introduction","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"introduction-1","createdAt":"2020-07-29T18:35:56.116Z","category":"5ed892b261e0040028e64a2f","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"5f21c197d74b1507abda5a1e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Authentication","type":"basic","slug":"authentication","order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"authentication-1","createdAt":"2020-07-29T18:36:07.755Z","category":"5ed892b261e0040028e64a2f","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"5f21c33187b083070ed0d1dd","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Requests","type":"basic","slug":"requests","order":2,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2020-07-29T18:42:57.372Z","category":"5ed892b261e0040028e64a2f","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5f21c1b5b8b12105e7f9ccb2","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Errors","type":"basic","slug":"errors","order":3,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"errors-1","createdAt":"2020-07-29T18:36:37.971Z","category":"5ed892b261e0040028e64a2f","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"5f21c276e8ddd707f9bfe09e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Pagination","type":"basic","slug":"pagination","order":4,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"pagination-1","createdAt":"2020-07-29T18:39:50.110Z","category":"5ed892b261e0040028e64a2f","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"5f21c24b40f912003d80e0e3","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Rate Limits","type":"basic","slug":"limitations","order":5,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"limitations-1","createdAt":"2020-07-29T18:39:07.412Z","category":"5ed892b261e0040028e64a2f","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]}]},{"_id":"5f21c0f730340d03af4c5117","title":"gorgias rest api","slug":"gorgias-rest-api","order":1,"reference":true,"isAPI":true,"project":"5ecd911e605d8a005f87ad63","version":"5ecd911e605d8a005f87ad69","createdAt":"2020-07-29T18:33:27.689Z","__v":0,"pages":[{"_id":"5f21c0f930340d03af4c5118","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Account","type":"basic","slug":"account","order":0,"isReference":true,"hidden":false,"sync_unique":"tag__Account","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-07-29T18:33:29.386Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"5f2debd0518476004432582d","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The Account object","type":"basic","slug":"the-account-object","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-08T00:03:28.876Z","parentDoc":"5f21c0f930340d03af4c5118","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae0c1","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve your account","icon":"","type":"endpoint","slug":"get-account","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-account","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.927Z","parentDoc":"5f21c0f930340d03af4c5118","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"671b92a58ad934002a7a0de0","mdx":{},"api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Create a setting","icon":"","type":"endpoint","slug":"create-account-setting","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"create-account-setting","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-10-25T12:44:21.659Z","parentDoc":"5f21c0f930340d03af4c5118","isBodyEmpty":true,"children":[]},{"_id":"671b92a58ad934002a7a0de1","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List settings","icon":"","type":"endpoint","slug":"list-account-settings","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-account-settings","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-10-25T12:44:21.660Z","parentDoc":"5f21c0f930340d03af4c5118","isBodyEmpty":true,"children":[]},{"_id":"671b92a58ad934002a7a0de2","mdx":{},"api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update a setting","icon":"","type":"endpoint","slug":"update-account-setting","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-account-setting","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-10-25T12:44:21.660Z","parentDoc":"5f21c0f930340d03af4c5118","isBodyEmpty":true,"children":[]}]},{"_id":"5f2de030ef4f2800338be13b","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Customers","type":"basic","slug":"customers","order":1,"isReference":true,"hidden":false,"sync_unique":"tag__Customers","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-07T23:13:52.563Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"5f2debd1059063026198b134","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"The Customer object","type":"basic","slug":"the-customer-object","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-08T00:03:29.860Z","parentDoc":"5f2de030ef4f2800338be13b","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"5f2debcf4dd7ad023cb9da72","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The CustomerChannel object","type":"basic","slug":"the-customerchannel-object","order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-08T00:03:27.819Z","parentDoc":"5f2de030ef4f2800338be13b","isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae0c2","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Create a customer","icon":"","type":"endpoint","slug":"create-customer","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"create-customer","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.927Z","parentDoc":"5f2de030ef4f2800338be13b","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0c4","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Delete customers","icon":"","type":"endpoint","slug":"delete-customers","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete-customers","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.928Z","parentDoc":"5f2de030ef4f2800338be13b","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0c3","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List customers","icon":"","type":"endpoint","slug":"list-customers","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-customers","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.928Z","parentDoc":"5f2de030ef4f2800338be13b","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0c7","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Delete a customer","icon":"","type":"endpoint","slug":"delete-customer","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete-customer","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.929Z","parentDoc":"5f2de030ef4f2800338be13b","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0c5","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve a customer","icon":"","type":"endpoint","slug":"get-customer","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-customer","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.928Z","parentDoc":"5f2de030ef4f2800338be13b","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0c6","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update a customer","icon":"","type":"endpoint","slug":"update-customer","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-customer","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.929Z","parentDoc":"5f2de030ef4f2800338be13b","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0c8","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Merge two customers","icon":"","type":"endpoint","slug":"merge-customers","order":8,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"merge-customers","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.930Z","parentDoc":"5f2de030ef4f2800338be13b","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0c9","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Set customer data","icon":"","type":"endpoint","slug":"update-customer-data","order":9,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-customer-data","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.930Z","parentDoc":"5f2de030ef4f2800338be13b","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6798e87692ae28006f8a73cb","mdx":{},"api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Delete customer field value","icon":"","type":"endpoint","slug":"delete-customer-custom-field-value","order":10,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete-customer-custom-field-value","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2025-01-28T14:23:50.295Z","parentDoc":"5f2de030ef4f2800338be13b","isBodyEmpty":true,"children":[]},{"_id":"6798e87692ae28006f8a73cc","mdx":{},"api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update customer field value","icon":"","type":"endpoint","slug":"update-customer-custom-field-value","order":11,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-customer-custom-field-value","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2025-01-28T14:23:50.295Z","parentDoc":"5f2de030ef4f2800338be13b","isBodyEmpty":true,"children":[]},{"_id":"6798e87692ae28006f8a73cd","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List customer field values","icon":"","type":"endpoint","slug":"list-customer-custom-fields-values","order":12,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-customer-custom-fields-values","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2025-01-28T14:23:50.296Z","parentDoc":"5f2de030ef4f2800338be13b","isBodyEmpty":true,"children":[]},{"_id":"6798e87692ae28006f8a73ce","mdx":{},"api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update customer fields values","icon":"","type":"endpoint","slug":"update-customer-custom-field-values","order":13,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-customer-custom-field-values","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2025-01-28T14:23:50.296Z","parentDoc":"5f2de030ef4f2800338be13b","isBodyEmpty":true,"children":[]}]},{"_id":"6435d54c3b18090510b068e4","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Custom Fields","icon":"","type":"basic","slug":"custom-fields","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Custom Fields","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2023-04-11T21:46:52.652Z","parentDoc":null,"mdx":{},"isBodyEmpty":true,"children":[{"_id":"6435d556687389007cd27db4","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The CustomField object","icon":"","type":"basic","slug":"the-customfield-object","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2023-04-11T21:47:02.517Z","parentDoc":"6435d54c3b18090510b068e4","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae0ca","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Create a custom field","icon":"","type":"endpoint","slug":"create-custom-field","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"create-custom-field","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.930Z","parentDoc":"6435d54c3b18090510b068e4","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0cb","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List custom fields","icon":"","type":"endpoint","slug":"list-custom-fields","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-custom-fields","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.931Z","parentDoc":"6435d54c3b18090510b068e4","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0cc","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Bulk update a list of custom fields","icon":"","type":"endpoint","slug":"update-custom-fields","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-custom-fields","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.931Z","parentDoc":"6435d54c3b18090510b068e4","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0cd","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve a custom field","icon":"","type":"endpoint","slug":"get-custom-field","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-custom-field","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.932Z","parentDoc":"6435d54c3b18090510b068e4","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0ce","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update a custom field","icon":"","type":"endpoint","slug":"update-custom-field","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-custom-field","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.932Z","parentDoc":"6435d54c3b18090510b068e4","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"5f21c0f930340d03af4c5119","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Events","type":"basic","slug":"events","order":3,"isReference":true,"hidden":false,"sync_unique":"tag__Events","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-07-29T18:33:29.388Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"5f2debd2ab1f9b00653aa560","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The Event object","type":"basic","slug":"the-event-object","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-08T00:03:30.896Z","parentDoc":"5f21c0f930340d03af4c5119","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae0d0","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve an event","icon":"","type":"endpoint","slug":"get-event","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-event","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.933Z","parentDoc":"5f21c0f930340d03af4c5119","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0cf","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List events","icon":"","type":"endpoint","slug":"list-events","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-events","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.933Z","parentDoc":"5f21c0f930340d03af4c5119","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"5f21c0f930340d03af4c511a","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Files","type":"basic","slug":"files","order":4,"isReference":true,"hidden":false,"sync_unique":"tag__Files","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-07-29T18:33:29.390Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"5f2debd37633f80232b394a5","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The File object","type":"basic","slug":"the-file-object","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-08T00:03:31.954Z","parentDoc":"5f21c0f930340d03af4c511a","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"5f21c0f930340d03af4c5132","api":{"method":"post","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116","results":{"codes":[]}},"title":"Upload files","type":"endpoint","slug":"post_api-upload","order":1,"isReference":true,"hidden":false,"sync_unique":"post_api-upload","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-07-29T18:33:29.841Z","parentDoc":"5f21c0f930340d03af4c511a","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0d1","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Download a file","icon":"","type":"endpoint","slug":"download-file","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"download-file","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.934Z","parentDoc":"5f21c0f930340d03af4c511a","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"6022d03173b57b001b69e6a8","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Integrations","type":"basic","slug":"integrations","order":5,"isReference":true,"hidden":false,"sync_unique":"tag__Integrations","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2021-02-09T18:10:57.885Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"60130fdc1716b601bb32f591","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The Integration object","type":"basic","slug":"the-integration-object","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2021-01-28T19:26:20.908Z","parentDoc":"6022d03173b57b001b69e6a8","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"67e4250e9158640018e15109","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"The TicketHttpIntegration object","icon":"","type":"basic","slug":"the-tickethttpintegration-object","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2025-03-26T16:02:22.621Z","parentDoc":"6022d03173b57b001b69e6a8","isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae0d2","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Create an integration","icon":"","type":"endpoint","slug":"create-integration","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"create-integration","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.935Z","parentDoc":"6022d03173b57b001b69e6a8","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0d3","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List integrations","icon":"","type":"endpoint","slug":"list-integrations","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-integrations","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.935Z","parentDoc":"6022d03173b57b001b69e6a8","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0d6","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Delete an integration","icon":"","type":"endpoint","slug":"delete-integration","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete-integration","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.937Z","parentDoc":"6022d03173b57b001b69e6a8","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0d4","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve an integration","icon":"","type":"endpoint","slug":"get-integration","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-integration","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.936Z","parentDoc":"6022d03173b57b001b69e6a8","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0d5","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update an integration","icon":"","type":"endpoint","slug":"update-integration","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-integration","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.936Z","parentDoc":"6022d03173b57b001b69e6a8","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"5f21c0f930340d03af4c511b","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Jobs","type":"basic","slug":"jobs","order":6,"isReference":true,"hidden":false,"sync_unique":"tag__Jobs","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-07-29T18:33:29.391Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"5f2debd491c43e019ec5bfbe","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The Job object","type":"basic","slug":"the-job-object","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-08T00:03:32.944Z","parentDoc":"5f21c0f930340d03af4c511b","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae0d7","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Create a job","icon":"","type":"endpoint","slug":"create-job","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"create-job","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.937Z","parentDoc":"5f21c0f930340d03af4c511b","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0d8","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List jobs","icon":"","type":"endpoint","slug":"list-jobs","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-jobs","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.937Z","parentDoc":"5f21c0f930340d03af4c511b","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0db","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Cancel a job","icon":"","type":"endpoint","slug":"cancel-job","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"cancel-job","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.939Z","parentDoc":"5f21c0f930340d03af4c511b","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0d9","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve a job","icon":"","type":"endpoint","slug":"get-job","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-job","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.938Z","parentDoc":"5f21c0f930340d03af4c511b","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0da","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update a job","icon":"","type":"endpoint","slug":"update-job","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-job","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.938Z","parentDoc":"5f21c0f930340d03af4c511b","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"5f21c0f930340d03af4c511c","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Macros","type":"basic","slug":"macros","order":7,"isReference":true,"hidden":false,"sync_unique":"tag__Macros","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-07-29T18:33:29.393Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"5f2debd630f2db002c8a7f81","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"The Macro object","type":"basic","slug":"the-macro-object","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-08T00:03:34.799Z","parentDoc":"5f21c0f930340d03af4c511c","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"5f2debd55c64bc02292f8e5e","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The MacroAction object","type":"basic","slug":"the-macroaction-object","order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-08T00:03:33.788Z","parentDoc":"5f21c0f930340d03af4c511c","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae0dc","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Create a macro","icon":"","type":"endpoint","slug":"create-macro","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"create-macro","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.939Z","parentDoc":"5f21c0f930340d03af4c511c","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0dd","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List macros","icon":"","type":"endpoint","slug":"list-macros","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-macros","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.940Z","parentDoc":"5f21c0f930340d03af4c511c","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0e0","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Delete a macro","icon":"","type":"endpoint","slug":"delete-macro","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete-macro","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.941Z","parentDoc":"5f21c0f930340d03af4c511c","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0de","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve a macro","icon":"","type":"endpoint","slug":"get-macro","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-macro","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.940Z","parentDoc":"5f21c0f930340d03af4c511c","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0df","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update a macro","icon":"","type":"endpoint","slug":"update-macro","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-macro","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.941Z","parentDoc":"5f21c0f930340d03af4c511c","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6798e87692ae28006f8a73cf","mdx":{},"api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Archive macros","icon":"","type":"endpoint","slug":"bulk-archive-macros","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"bulk-archive-macros","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2025-01-28T14:23:50.302Z","parentDoc":"5f21c0f930340d03af4c511c","isBodyEmpty":true,"children":[]},{"_id":"6798e87692ae28006f8a73d0","mdx":{},"api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Unarchive macros","icon":"","type":"endpoint","slug":"bulk-unarchive-macros","order":8,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"bulk-unarchive-macros","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2025-01-28T14:23:50.303Z","parentDoc":"5f21c0f930340d03af4c511c","isBodyEmpty":true,"children":[]}]},{"_id":"5f21c0f930340d03af4c511d","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Rules","type":"basic","slug":"rules","order":8,"isReference":true,"hidden":false,"sync_unique":"tag__Rules","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-07-29T18:33:29.394Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"5f2debd71207d10251cd3e27","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The Rule object","type":"basic","slug":"the-rule-object","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-08T00:03:35.957Z","parentDoc":"5f21c0f930340d03af4c511d","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae0e1","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Create a rule","icon":"","type":"endpoint","slug":"create-rule","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"create-rule","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.942Z","parentDoc":"5f21c0f930340d03af4c511d","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0e2","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List rules","icon":"","type":"endpoint","slug":"list-rules","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-rules","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.942Z","parentDoc":"5f21c0f930340d03af4c511d","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0e5","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Delete a rule","icon":"","type":"endpoint","slug":"delete-rule","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete-rule","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.944Z","parentDoc":"5f21c0f930340d03af4c511d","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0e3","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve a rule","icon":"","type":"endpoint","slug":"get-rule","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-rule","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.943Z","parentDoc":"5f21c0f930340d03af4c511d","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0e4","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update a rule","icon":"","type":"endpoint","slug":"update-rule","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-rule","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.943Z","parentDoc":"5f21c0f930340d03af4c511d","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0e6","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update rules' priorities","icon":"","type":"endpoint","slug":"update-rules-priorities","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-rules-priorities","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.945Z","parentDoc":"5f21c0f930340d03af4c511d","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"5f21c0f930340d03af4c511e","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Satisfaction Surveys","type":"basic","slug":"satisfaction-surveys","order":9,"isReference":true,"hidden":false,"sync_unique":"tag__Satisfaction Surveys","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-07-29T18:33:29.396Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"5f2debd8c1a8a702b8aa87e1","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The SatisfactionSurvey object","type":"basic","slug":"the-satisfactionsurvey-object","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-08T00:03:36.459Z","parentDoc":"5f21c0f930340d03af4c511e","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae0e7","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Create a survey","icon":"","type":"endpoint","slug":"create-satisfaction-survey","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"create-satisfaction-survey","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.946Z","parentDoc":"5f21c0f930340d03af4c511e","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0e8","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List surveys","icon":"","type":"endpoint","slug":"list-satisfaction-surveys","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-satisfaction-surveys","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.946Z","parentDoc":"5f21c0f930340d03af4c511e","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0e9","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve a survey","icon":"","type":"endpoint","slug":"get-satisfaction-survey","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-satisfaction-survey","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.947Z","parentDoc":"5f21c0f930340d03af4c511e","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0ea","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update a survey","icon":"","type":"endpoint","slug":"update-satisfaction-survey","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-satisfaction-survey","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.948Z","parentDoc":"5f21c0f930340d03af4c511e","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"5f21c0f930340d03af4c511f","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Search","type":"basic","slug":"search","order":10,"isReference":true,"hidden":false,"sync_unique":"tag__Search","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-07-29T18:33:29.397Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"6614d4479332850025fae0eb","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Search for resources","icon":"","type":"endpoint","slug":"search-1","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"search","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.949Z","parentDoc":"5f21c0f930340d03af4c511f","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"5f21c0f930340d03af4c5120","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Statistics","type":"basic","slug":"statistics","order":11,"isReference":true,"hidden":false,"sync_unique":"tag__Statistics","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-07-29T18:33:29.399Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"5f2debded9793b0012e64134","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"The Statistic object","type":"basic","slug":"the-statistic-object","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-08T00:03:42.062Z","parentDoc":"5f21c0f930340d03af4c5120","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"5f21c0f930340d03af4c5148","api":{"method":"post","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116","results":{"codes":[]}},"title":"Retrieve a statistic","type":"endpoint","slug":"post_api-stats-name","order":1,"isReference":true,"hidden":false,"sync_unique":"post_api-stats-name","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-07-29T18:33:29.928Z","parentDoc":"5f21c0f930340d03af4c5120","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"5f21c0f930340d03af4c5149","api":{"method":"post","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116","results":{"codes":[]}},"title":"Download a statistic","type":"endpoint","slug":"post_api-stats-name-download","order":2,"isReference":true,"hidden":false,"sync_unique":"post_api-stats-name-download","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-07-29T18:33:29.930Z","parentDoc":"5f21c0f930340d03af4c5120","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"5f21c0f930340d03af4c5122","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Tags","type":"basic","slug":"tags","order":12,"isReference":true,"hidden":false,"sync_unique":"tag__Tags","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-07-29T18:33:29.401Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"5f2debda1207d10251cd3e29","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The Tag object","type":"basic","slug":"the-tag-object","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-08T00:03:38.974Z","parentDoc":"5f21c0f930340d03af4c5122","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae0f6","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Create a tag","icon":"","type":"endpoint","slug":"create-tag","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"create-tag","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.957Z","parentDoc":"5f21c0f930340d03af4c5122","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0f8","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Delete tags","icon":"","type":"endpoint","slug":"delete-tags","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete-tags","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.959Z","parentDoc":"5f21c0f930340d03af4c5122","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0f7","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List tags","icon":"","type":"endpoint","slug":"list-tags","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-tags","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.958Z","parentDoc":"5f21c0f930340d03af4c5122","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0fb","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Delete a tag","icon":"","type":"endpoint","slug":"delete-tag","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete-tag","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.961Z","parentDoc":"5f21c0f930340d03af4c5122","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0f9","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve a tag","icon":"","type":"endpoint","slug":"get-tag","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-tag","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.960Z","parentDoc":"5f21c0f930340d03af4c5122","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0fa","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update a tag","icon":"","type":"endpoint","slug":"update-tag","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-tag","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.961Z","parentDoc":"5f21c0f930340d03af4c5122","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0fc","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Merge tags","icon":"","type":"endpoint","slug":"merge-tags","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"merge-tags","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.961Z","parentDoc":"5f21c0f930340d03af4c5122","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"62e7ee17cc158200a4fcbd19","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Teams","icon":"","type":"basic","slug":"teams","order":13,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Teams","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2022-08-01T15:15:35.361Z","parentDoc":null,"mdx":{},"isBodyEmpty":true,"children":[{"_id":"62e7ee20c38f2f005079523b","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The Team object","icon":"","type":"basic","slug":"the-team-object","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2022-08-01T15:15:44.269Z","parentDoc":"62e7ee17cc158200a4fcbd19","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae0f1","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Create a team","icon":"","type":"endpoint","slug":"create-team","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"create-team","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.954Z","parentDoc":"62e7ee17cc158200a4fcbd19","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0f2","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List teams","icon":"","type":"endpoint","slug":"list-teams","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-teams","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.954Z","parentDoc":"62e7ee17cc158200a4fcbd19","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0f5","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Delete a team","icon":"","type":"endpoint","slug":"delete-team","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete-team","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.957Z","parentDoc":"62e7ee17cc158200a4fcbd19","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0f3","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve a team","icon":"","type":"endpoint","slug":"get-team","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-team","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.955Z","parentDoc":"62e7ee17cc158200a4fcbd19","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0f4","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update a team","icon":"","type":"endpoint","slug":"update-team","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-team","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.956Z","parentDoc":"62e7ee17cc158200a4fcbd19","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"5f2de030ef4f2800338be13d","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Tickets","type":"basic","slug":"tickets","order":14,"isReference":true,"hidden":false,"sync_unique":"tag__Tickets","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-07T23:13:52.568Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"5f2debdce0605e0211422592","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The Ticket object","type":"basic","slug":"the-ticket-object","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-08T00:03:40.266Z","parentDoc":"5f2de030ef4f2800338be13d","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae0fd","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Create a ticket","icon":"","type":"endpoint","slug":"create-ticket","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"create-ticket","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.962Z","parentDoc":"5f2de030ef4f2800338be13d","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0fe","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List tickets","icon":"","type":"endpoint","slug":"list-tickets","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-tickets","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.962Z","parentDoc":"5f2de030ef4f2800338be13d","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae101","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Delete a ticket","icon":"","type":"endpoint","slug":"delete-ticket","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete-ticket","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.964Z","parentDoc":"5f2de030ef4f2800338be13d","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0ff","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve a ticket","icon":"","type":"endpoint","slug":"get-ticket","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-ticket","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.963Z","parentDoc":"5f2de030ef4f2800338be13d","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae100","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update a ticket","icon":"","type":"endpoint","slug":"update-ticket","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-ticket","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.963Z","parentDoc":"5f2de030ef4f2800338be13d","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae107","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Add ticket tags","icon":"","type":"endpoint","slug":"create-ticket-tags","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"create-ticket-tags","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.966Z","parentDoc":"5f2de030ef4f2800338be13d","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae109","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Remove ticket tags","icon":"","type":"endpoint","slug":"delete-ticket-tags","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete-ticket-tags","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.967Z","parentDoc":"5f2de030ef4f2800338be13d","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"627e6d585e093e0536085a47","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List ticket tags","type":"endpoint","slug":"get_api-tickets-ticket-id-tags","order":8,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_api-tickets-ticket-id-tags","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2022-05-13T14:38:16.432Z","parentDoc":"5f2de030ef4f2800338be13d","icon":"","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae108","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Set ticket tags","icon":"","type":"endpoint","slug":"update-ticket-tags","order":9,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-ticket-tags","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.967Z","parentDoc":"5f2de030ef4f2800338be13d","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae10d","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Delete ticket field value","icon":"","type":"endpoint","slug":"delete-ticket-custom-field","order":10,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete-ticket-custom-field","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.969Z","parentDoc":"5f2de030ef4f2800338be13d","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae10c","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update ticket field value","icon":"","type":"endpoint","slug":"update-ticket-custom-field","order":11,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-ticket-custom-field","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.968Z","parentDoc":"5f2de030ef4f2800338be13d","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae10a","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List ticket field values","icon":"","type":"endpoint","slug":"list-ticket-custom-fields","order":12,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-ticket-custom-fields","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.968Z","parentDoc":"5f2de030ef4f2800338be13d","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae10b","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update ticket fields values","icon":"","type":"endpoint","slug":"update-ticket-custom-fields","order":13,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-ticket-custom-fields","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.968Z","parentDoc":"5f2de030ef4f2800338be13d","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"5f2de030ef4f2800338be13e","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Ticket Messages","type":"basic","slug":"ticket-messages","order":15,"isReference":true,"hidden":false,"sync_unique":"tag__Ticket Messages","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-07T23:13:52.569Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"5f2debdd8c2e460273fac9d0","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The TicketMessage object","type":"basic","slug":"the-ticketmessage-object","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-08T00:03:41.049Z","parentDoc":"5f2de030ef4f2800338be13e","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae102","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Create a message","icon":"","type":"endpoint","slug":"create-ticket-message","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"create-ticket-message","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.964Z","parentDoc":"5f2de030ef4f2800338be13e","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae103","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List messages of a ticket","icon":"","type":"endpoint","slug":"list-ticket-messages","order":2,"isReference":true,"deprecated":true,"hidden":false,"sync_unique":"list-ticket-messages","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.965Z","parentDoc":"5f2de030ef4f2800338be13e","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae106","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Delete a message","icon":"","type":"endpoint","slug":"delete-ticket-message","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete-ticket-message","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.966Z","parentDoc":"5f2de030ef4f2800338be13e","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae104","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve a message","icon":"","type":"endpoint","slug":"get-ticket-message","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-ticket-message","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.965Z","parentDoc":"5f2de030ef4f2800338be13e","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae105","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update a message","icon":"","type":"endpoint","slug":"update-ticket-message","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-ticket-message","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.965Z","parentDoc":"5f2de030ef4f2800338be13e","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae10e","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List messages","icon":"","type":"endpoint","slug":"list-messages","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-messages","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.969Z","parentDoc":"5f2de030ef4f2800338be13e","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"5f2de030ef4f2800338be13c","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Users","type":"basic","slug":"users","order":16,"isReference":true,"hidden":false,"sync_unique":"tag__Users","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-07T23:13:52.567Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"5f2debd8e49d45002f231493","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The User object","type":"basic","slug":"the-user-object","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-08T00:03:36.958Z","parentDoc":"5f2de030ef4f2800338be13c","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae0ec","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Create a user","icon":"","type":"endpoint","slug":"create-user","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"create-user","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.950Z","parentDoc":"5f2de030ef4f2800338be13c","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0ed","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List users","icon":"","type":"endpoint","slug":"list-users","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-users","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.950Z","parentDoc":"5f2de030ef4f2800338be13c","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0f0","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Delete a user","icon":"","type":"endpoint","slug":"delete-user","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete-user","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.953Z","parentDoc":"5f2de030ef4f2800338be13c","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0ee","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve a user","icon":"","type":"endpoint","slug":"get-user","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-user","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.951Z","parentDoc":"5f2de030ef4f2800338be13c","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0ef","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update a user","icon":"","type":"endpoint","slug":"update-user","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-user","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.952Z","parentDoc":"5f2de030ef4f2800338be13c","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"5f21c0f930340d03af4c5121","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Views","type":"basic","slug":"views","order":17,"isReference":true,"hidden":false,"sync_unique":"tag__Views","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-07-29T18:33:29.400Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"5f2debdfffaf85017fcd6640","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The View object","type":"basic","slug":"the-view-object","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-08T00:03:43.144Z","parentDoc":"5f21c0f930340d03af4c5121","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae10f","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Create a view","icon":"","type":"endpoint","slug":"create-view","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"create-view","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.970Z","parentDoc":"5f21c0f930340d03af4c5121","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae110","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List views","icon":"","type":"endpoint","slug":"list-views","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-views","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.971Z","parentDoc":"5f21c0f930340d03af4c5121","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae113","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Delete a view","icon":"","type":"endpoint","slug":"delete-view","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete-view","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.972Z","parentDoc":"5f21c0f930340d03af4c5121","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae111","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve a view","icon":"","type":"endpoint","slug":"get-view","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-view","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.971Z","parentDoc":"5f21c0f930340d03af4c5121","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae112","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update a view","icon":"","type":"endpoint","slug":"update-view","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-view","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.971Z","parentDoc":"5f21c0f930340d03af4c5121","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae114","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List view's items","icon":"","type":"endpoint","slug":"list-view-items","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-view-items","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.973Z","parentDoc":"5f21c0f930340d03af4c5121","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae115","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Search for view's items","icon":"","type":"endpoint","slug":"update-view-items","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-view-items","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.973Z","parentDoc":"5f21c0f930340d03af4c5121","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"64958146cacc9a000bb4dca0","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Voice Calls","icon":"","type":"basic","slug":"voice-calls","order":18,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Voice Calls","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2023-06-23T11:25:58.388Z","parentDoc":null,"mdx":{},"isBodyEmpty":true,"children":[{"_id":"64f5e40a0d548b00434a9cd7","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The VoiceCall object","icon":"","type":"basic","slug":"the-voicecall-object","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2023-09-04T14:04:58.606Z","parentDoc":"64958146cacc9a000bb4dca0","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae117","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve a voice call","icon":"","type":"endpoint","slug":"get-voice-call","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-voice-call","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.975Z","parentDoc":"64958146cacc9a000bb4dca0","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae116","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List voice calls","icon":"","type":"endpoint","slug":"list-voice-calls","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-voice-calls","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.974Z","parentDoc":"64958146cacc9a000bb4dca0","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"64958146cacc9a000bb4dca1","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Voice Call Recordings","icon":"","type":"basic","slug":"voice-call-recordings","order":19,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Voice Call Recordings","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2023-06-23T11:25:58.388Z","parentDoc":null,"mdx":{},"isBodyEmpty":true,"children":[{"_id":"64f5e40bd84c6d006d37680d","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The VoiceCallRecording object","icon":"","type":"basic","slug":"the-voicecallrecording-object","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2023-09-04T14:04:59.136Z","parentDoc":"64958146cacc9a000bb4dca1","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae11a","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Delete a voice call recording","icon":"","type":"endpoint","slug":"delete-voice-call-recording","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete-voice-call-recording","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.977Z","parentDoc":"64958146cacc9a000bb4dca1","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae119","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve a voice call recording","icon":"","type":"endpoint","slug":"get-voice-call-recording","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-voice-call-recording","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.976Z","parentDoc":"64958146cacc9a000bb4dca1","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae118","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List voice call recordings","icon":"","type":"endpoint","slug":"list-voice-call-recordings","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-voice-call-recordings","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.976Z","parentDoc":"64958146cacc9a000bb4dca1","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"64ef0c350b0f9d0bd9bed753","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Voice Call Events","icon":"","type":"basic","slug":"voice-call-events","order":20,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Voice Call Events","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2023-08-30T09:30:29.509Z","parentDoc":null,"mdx":{},"isBodyEmpty":true,"children":[{"_id":"64f5e40b10083500407a0803","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The VoiceCallEvent object","icon":"","type":"basic","slug":"the-voicecallevent-object","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2023-09-04T14:04:59.498Z","parentDoc":"64ef0c350b0f9d0bd9bed753","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae11c","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve a voice call event","icon":"","type":"endpoint","slug":"get-voice-call-event","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-voice-call-event","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.978Z","parentDoc":"64ef0c350b0f9d0bd9bed753","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae11b","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List voice call events","icon":"","type":"endpoint","slug":"list-voice-call-events","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-voice-call-events","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.978Z","parentDoc":"64ef0c350b0f9d0bd9bed753","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"6005e1a0ec3fce00378f9bdd","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Widgets","type":"basic","slug":"widgets","order":21,"isReference":true,"hidden":false,"sync_unique":"tag__Widgets","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2021-01-18T19:29:36.285Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"6005e1a7814c540081e47576","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"The Widget object","type":"basic","slug":"the-widget-object","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2021-01-18T19:29:43.744Z","parentDoc":"6005e1a0ec3fce00378f9bdd","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae11d","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Create a widget","icon":"","type":"endpoint","slug":"create-widget","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"create-widget","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.979Z","parentDoc":"6005e1a0ec3fce00378f9bdd","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae11e","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List widgets","icon":"","type":"endpoint","slug":"list-widgets","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-widgets","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.980Z","parentDoc":"6005e1a0ec3fce00378f9bdd","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae121","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Delete a widget","icon":"","type":"endpoint","slug":"delete-widget","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete-widget","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.981Z","parentDoc":"6005e1a0ec3fce00378f9bdd","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae11f","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve a widget","icon":"","type":"endpoint","slug":"get-widget","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-widget","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.980Z","parentDoc":"6005e1a0ec3fce00378f9bdd","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae120","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update a widget","icon":"","type":"endpoint","slug":"update-widget","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-widget","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.981Z","parentDoc":"6005e1a0ec3fce00378f9bdd","mdx":{},"isBodyEmpty":true,"children":[]}]}]}]},"apiBaseUrl":"/","baseUrl":"/","search":{"appId":"T28YKFATPY","searchApiKey":"NjE3NWQxODNjOGZlZDcwNGVmYWFmYTYwYzdjMGIxYmU4NjJjZWUyNGE2NzI1ZDM0OTgzNzVkMWYwZmNhZTU0Y3RhZ0ZpbHRlcnM9KHByb2plY3Q6NWVjZDkxMWU2MDVkOGEwMDVmODdhZDYzKSwodmVyc2lvbjpub25lLHZlcnNpb246NWVjZDkxMWU2MDVkOGEwMDVmODdhZDY5KSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlLGluZGV4OkJsb2cp","indexName":"readme_search_v2","projectsMeta":[{"modules":{"landing":true,"docs":true,"examples":true,"reference":true,"changelog":true,"discuss":false,"suggested_edits":true,"logs":false,"custompages":true,"tutorials":false,"graphql":false},"id":"5ecd911e605d8a005f87ad63","name":"gorgias-developers","subdomain":"gorgias-developers","subpath":"","nav_names":{"docs":"Quickstart","reference":"","changelog":"","discuss":"","tutorials":"","recipes":""}}],"UrlManager":{"options":{"child":false,"parent":null,"hasOneChild":false,"project":null,"version":null,"lang":"en"},"defaults":{"lang":"en"}},"urlManagerOpts":{"lang":"en","parent":{"childrenProjects":[]},"project":{"subdomain":"gorgias-developers"},"version":"1.0"}},"changelogs":[{"metadata":{"image":[],"title":"","description":"","keywords":""},"mdx":{"altBody":"","status":"rdmd"},"algolia":{"recordCount":1,"publishPending":false,"updatedAt":"2025-02-19T17:00:08.991Z"},"title":"API Rate Limits Improvements","slug":"api-rate-limits-improvements","body":"**Effective Date:** Immediate\n\nWe’ve made optimizations to our API infrastructure, resulting in increased rate limits for certain use cases. These improvements enhance performance for tasks like bulk imports, exports, and syncing operations.\n\nFor full details, please refer to our [documentation on rate limits](https://developers.gorgias.com/reference/limitations).\n\nBest, \nGorgias Developer Relations Team","searchContents":"Effective Date: Immediate We’ve made optimizations to our API infrastructure, resulting in increased rate limits for certain use cases. These improvements enhance performance for tasks like bulk imports, exports, and syncing operations. For full details, please refer to our documentation on rate limits . Best, Gorgias Developer Relations Team","type":"improved","hidden":false,"revision":2,"_id":"67b60e18d5e3f700692417d0","user":{"name":"Akshay Bhasin","_id":"67532f0903ee5a2a6b13833c"},"project":"5ecd911e605d8a005f87ad63","createdAt":"2025-02-19T17:00:08.582Z","updatedAt":"2025-02-19T17:00:08.582Z","lastUpdatedHash":"1d34259b43d6f3ddd2834f0a1ab26f4a236cc2ac","__v":0},{"metadata":{"image":[],"title":"","description":"","keywords":""},"mdx":{"altBody":"","status":"rdmd"},"algolia":{"recordCount":1,"publishPending":false,"updatedAt":"2025-01-21T04:24:12.209Z"},"title":"TLS 1.2 Security Update scheduled on Dec 11","slug":"tls-12-security-update-scheduled-on-dec-11","body":"Hello Partners,\n\nWe’re implementing an update to improve security across our platform by enforcing TLS 1.2 and above. As part of this update, we will temporarily switch endpoints to TLS 1.2 and above for 12 hours on Wednesday, Dec 11th, 2024, to ensure readiness ahead of a full, permanent rollout the following week.\n\nMost modern browsers and SDK clients already support TLS 1.2 and above, so we expect minimal impact. If you have any questions or concerns, please contact us at [support-dev-rel@gorgias.com](mailto:support-dev-rel@gorgias.com).\n\nThank you for your cooperation!\n\nBest, \nGorgias Developer Relations Team","searchContents":"Hello Partners, We’re implementing an update to improve security across our platform by enforcing TLS 1.2 and above. As part of this update, we will temporarily switch endpoints to TLS 1.2 and above for 12 hours on Wednesday, Dec 11th, 2024, to ensure readiness ahead of a full, permanent rollout the following week. Most modern browsers and SDK clients already support TLS 1.2 and above, so we expect minimal impact. If you have any questions or concerns, please contact us at support-dev-rel@gorgias.com . Thank you for your cooperation! Best, Gorgias Developer Relations Team","type":"","hidden":false,"revision":2,"_id":"675345d2f04ca2007ce084c7","user":{"name":"Akshay Bhasin","_id":"67532f0903ee5a2a6b13833c"},"project":"5ecd911e605d8a005f87ad63","createdAt":"2024-12-06T18:43:30.840Z","updatedAt":"2025-01-21T04:24:12.209Z","lastUpdatedHash":"85cfe49375dd55cf40eb01fd336dca55652ca57f","__v":0},{"metadata":{"image":[],"title":"","description":"","keywords":""},"mdx":{"altBody":"","status":"rdmd"},"algolia":{"recordCount":3,"publishPending":false,"updatedAt":"2025-01-21T04:24:15.491Z"},"title":"`self-service-overview` statistics will be removed from the Statistics API","slug":"self-service-overview-statistics-will-be-removed-from-the-statistics-api","body":"Starting from January 1, 2025, the `self-service-overview` option will be removed from [Statistics API](https://developers.gorgias.com/reference/post_api-stats-name) . \n\n### Motivation\n\nIt uses an old data source for providing Automate statistics and no longer matches the information shown in the app, which now uses a more reliable and accurate data source. \n\n### Migration\n\nUnfortunately there is no equivalent endpoint using the new data source at this moment.","searchContents":"Starting from January 1, 2025, the self-service-overview option will be removed from Statistics API . Motivation It uses an old data source for providing Automate statistics and no longer matches the information shown in the app, which now uses a more reliable and accurate data source. Migration Unfortunately there is no equivalent endpoint using the new data source at this moment.","type":"removed","hidden":false,"revision":5,"_id":"671b8fa263cf260011b49a36","user":{"name":"Ionut Zamfir","_id":"62ed1baf18fad002b224808a"},"project":"5ecd911e605d8a005f87ad63","createdAt":"2024-10-25T12:31:30.072Z","updatedAt":"2025-01-21T04:24:15.491Z","lastUpdatedHash":"1c7d6641b480114459f5b1532ee0df1f4223b595","__v":0},{"metadata":{"image":[],"title":"","description":"","keywords":""},"mdx":{"altBody":"","status":"rdmd"},"algolia":{"recordCount":1,"publishPending":false,"updatedAt":"2025-01-21T04:24:15.446Z"},"title":"Limit length of ticket subject","slug":"limit-ticket-subject-size","body":"Starting from Sep 01, 2024, ticket `subject` length is going to be limited to 998 characters.\n\nEndpoints such as [create](https://developers.gorgias.com/reference/create-ticket) or [update](https://developers.gorgias.com/reference/update-ticket) ticket will return HTTP error response (status code 400) when the length of ticket `subject` exceeds 998 characters.","searchContents":"Starting from Sep 01, 2024, ticket subject length is going to be limited to 998 characters. Endpoints such as create or update ticket will return HTTP error response (status code 400) when the length of ticket subject exceeds 998 characters.","type":"","hidden":false,"revision":8,"_id":"6683f167edacac004f8c3c24","user":{"name":"Jan Katrenic","_id":"615c1158b028e30050749ef8"},"project":"5ecd911e605d8a005f87ad63","createdAt":"2024-07-02T12:24:07.584Z","updatedAt":"2025-01-21T04:24:15.446Z","lastUpdatedHash":"344ae82f7951d6a4a6945e365ed19c5a351fd72a","__v":0},{"metadata":{"image":[],"title":"","description":"","keywords":""},"mdx":{"altBody":"","status":"rdmd"},"algolia":{"recordCount":3,"publishPending":false,"updatedAt":"2025-01-21T04:24:15.469Z"},"title":"The views items search resource pagination cursor format was changed","slug":"the-views-items-search-resource-pagination-cursor-format-was-changed","body":"Starting from **April 15, 2024**, a breaking change has been implemented affecting the format of cursor values returned in the API response of [views items search API](https://developers.gorgias.com/reference/update-view-items).\n\n### Change\n\n_Before_: Prior to this change, the format of the starting current_cursor value followed a specific pattern, exemplified by `WyJuZXh0IiwgIjI4MzMzNDQyNCJd`.\n\n```json json\n\"meta\": {\n \"current_cursor\": \"WyJuZXh0IiwgIjI4MzMzNDQyNCJd\",\n \"next_items\": \"/api/views/10/items/?direction=next&ignored_item=1781&cursor=WyJuZXh0IiwgIjI4MzM0MjgxNiJd\",\n \"prev_items\": null\n}\n```\n\n_After_: The resource changed resulting in a different cursor format in response body `WyJuZXh0IiwgIjE3MTMyOTMyMjIuNzAyIiwgIjI4MzMzNDQyNCJd`.\n\n```json JSON\n\"meta\": {\n \"current_cursor\": \"WyJuZXh0IiwgIjE2NjA0MzUyMDIiLCAiNjk4NjAxNCJd\",\n \"next_items\": \"/api/views/10/items/?direction=next&ignored_item=1781&cursor=WyJuZXh0IiwgIjE3MTMyODMyOTQuMTY2IiwgIjI4MzM0MjgxNiJd\",\n \"prev_items\": null\n}\n```\n\n<br>\n\n### Action required\n\nDevelopers utilizing the affected endpoint (`/api/views/0/items`) and preserving the cursor on their end for polling functionality are advised to reset their existing cursor values with the ones returned from the API. Keeping on using the previous cursors might result in response errors.","searchContents":"Starting from April 15, 2024 , a breaking change has been implemented affecting the format of cursor values returned in the API response of views items search API . Change Before : Prior to this change, the format of the starting current_cursor value followed a specific pattern, exemplified by WyJuZXh0IiwgIjI4MzMzNDQyNCJd . \"meta\": { \"current_cursor\": \"WyJuZXh0IiwgIjI4MzMzNDQyNCJd\", \"next_items\": \"/api/views/10/items/?direction=next&ignored_item=1781&cursor=WyJuZXh0IiwgIjI4MzM0MjgxNiJd\", \"prev_items\": null } After : The resource changed resulting in a different cursor format in response body WyJuZXh0IiwgIjE3MTMyOTMyMjIuNzAyIiwgIjI4MzMzNDQyNCJd . \"meta\": { \"current_cursor\": \"WyJuZXh0IiwgIjE2NjA0MzUyMDIiLCAiNjk4NjAxNCJd\", \"next_items\": \"/api/views/10/items/?direction=next&ignored_item=1781&cursor=WyJuZXh0IiwgIjE3MTMyODMyOTQuMTY2IiwgIjI4MzM0MjgxNiJd\", \"prev_items\": null } Action required Developers utilizing the affected endpoint ( /api/views/0/items ) and preserving the cursor on their end for polling functionality are advised to reset their existing cursor values with the ones returned from the API. Keeping on using the previous cursors might result in response errors.","type":"deprecated","hidden":false,"revision":6,"_id":"661eebe9c1bd9f002971b03f","user":{"name":"Illia Petrov","_id":"62ec63170c61f0036e3b6f6c"},"project":"5ecd911e605d8a005f87ad63","createdAt":"2024-04-16T21:21:45.708Z","updatedAt":"2025-01-21T04:24:15.469Z","lastUpdatedHash":"656c202908a39bff413d0e30d2a103f43821a4fc","__v":0}],"discuss":[{"anonymous_user":{"name":"Sana"},"algolia":{"recordCount":0,"publishPending":false,"updatedAt":"2025-01-21T04:24:01.817Z"},"title":"Updating the widgets on ticket clicks And Draft Messages","votes":0,"voters":[],"hub2voters":[],"views":44,"type":"question","solved":false,"body":"Hi ,\n\nIs there a way to updates lets say im using third party api to show some dynamic data based on ticket id/ticket email so for that i want to update the widget whenever im clicking on the tickets. \n\nNext query is do we have features to lets say click on a widget text and will be auto copied to the respond txt section area through any macros/rules","searchContents":"Hi , Is there a way to updates lets say im using third party api to show some dynamic data based on ticket id/ticket email so for that i want to update the widget whenever im clicking on the tickets. Next query is do we have features to lets say click on a widget text and will be auto copied to the respond txt section area through any macros/rules","isSpam":false,"isFAQ":false,"edited":false,"comments":[],"tags":[],"revision":46,"_id":"66950f2c1776ec0010ce43b5","createdAt":"2024-07-15T11:59:40.086Z","updatedAt":"2024-07-15T11:59:40.086Z","project":"5ecd911e605d8a005f87ad63","initVersion":"5ecd911e605d8a005f87ad69","__v":0,"effective_user":{"name":"Sana","isAdmin":false},"vote_count":0,"id":"66950f2c1776ec0010ce43b5"},{"anonymous_user":{"name":"Dean Majidy"},"algolia":{"recordCount":0,"publishPending":false,"updatedAt":"2025-01-21T04:24:01.812Z"},"title":"How to query via api tickets based on custom fields","votes":0,"voters":[],"hub2voters":[],"views":60,"type":"question","solved":false,"body":"Hey ya'll i'm new here to Gorgias so not to familiar with the in's and out's of the API. We have a custom field for our ticket's called \"Purchase Origin\" which return a list of choices which are set manually by our agent's.\n\nCurrently we can retrieve this data manually when going to statistics > ticket Insights >ticket fields > Purchase Origin (Amazon) > download manually\n\nI see how you can query custom fields to then retrieve the Id of that field but I don't see this as a param when querying ticket's or anything under the Statistics endpoint?\n\nThe only way I see it so far is under the \"List ticket field values\" endpoint with the ticket_id provided as a param but in this case i'd need to make 2 endpoint calls (one to retrieve the tickets and another to check ticket field values).\n\nChat & email support wasn't to helpful.\n\nI feel like their's got to be a better way to do this, even it involves changing our internal processes to accommodate for this. Thanks for all the help","searchContents":"Hey ya'll i'm new here to Gorgias so not to familiar with the in's and out's of the API. We have a custom field for our ticket's called \"Purchase Origin\" which return a list of choices which are set manually by our agent's. Currently we can retrieve this data manually when going to statistics > ticket Insights >ticket fields > Purchase Origin (Amazon) > download manually I see how you can query custom fields to then retrieve the Id of that field but I don't see this as a param when querying ticket's or anything under the Statistics endpoint? The only way I see it so far is under the \"List ticket field values\" endpoint with the ticket_id provided as a param but in this case i'd need to make 2 endpoint calls (one to retrieve the tickets and another to check ticket field values). Chat & email support wasn't to helpful. I feel like their's got to be a better way to do this, even it involves changing our internal processes to accommodate for this. Thanks for all the help","isSpam":false,"isFAQ":false,"edited":false,"comments":[],"tags":[],"revision":62,"_id":"668d942ed191d200707ec599","createdAt":"2024-07-09T19:49:02.686Z","updatedAt":"2024-07-09T19:49:02.686Z","project":"5ecd911e605d8a005f87ad63","initVersion":"5ecd911e605d8a005f87ad69","__v":0,"effective_user":{"name":"Dean Majidy","isAdmin":false},"vote_count":0,"id":"668d942ed191d200707ec599"},{"anonymous_user":{"name":"Spencer"},"algolia":{"recordCount":0,"publishPending":false,"updatedAt":"2025-01-21T04:24:01.819Z"},"title":"MacroActions Arguments documentation","votes":0,"voters":[],"hub2voters":[],"views":60,"type":"question","solved":false,"body":"The page on MacroActions (<https://developers.gorgias.com/reference/the-macroaction-object>) does not include any information on what the arguments object may contain. What are these possibilities, or is there a place they are documented?","searchContents":"The page on MacroActions ( https://developers.gorgias.com/reference/the-macroaction-object ) does not include any information on what the arguments object may contain. What are these possibilities, or is there a place they are documented?","isSpam":false,"isFAQ":false,"edited":false,"comments":[],"tags":[],"revision":62,"_id":"667f56fea68c68002926f8ca","createdAt":"2024-06-29T00:36:14.193Z","updatedAt":"2024-06-29T00:36:14.193Z","project":"5ecd911e605d8a005f87ad63","initVersion":"5ecd911e605d8a005f87ad69","__v":0,"effective_user":{"name":"Spencer","isAdmin":false},"vote_count":0,"id":"667f56fea68c68002926f8ca"},{"anonymous_user":{"name":"Anuj"},"algolia":{"recordCount":0,"publishPending":false,"updatedAt":"2025-01-21T04:24:01.822Z"},"title":"Attention Security Vulnerability Found!!!","votes":0,"voters":[],"hub2voters":[],"views":94,"type":"question","solved":false,"body":"I want to report a bug in your assets in an ethical way, so please tell me if you have a bug bounty or bug reward platform, else I'll send it here.","searchContents":"I want to report a bug in your assets in an ethical way, so please tell me if you have a bug bounty or bug reward platform, else I'll send it here.","isSpam":false,"isFAQ":false,"edited":false,"comments":["667da7d474b2ab0030f8624d","6687c547b090a000506c2836"],"tags":[],"revision":98,"_id":"667d492636b67f004c912a51","createdAt":"2024-06-27T11:12:38.393Z","updatedAt":"2024-06-27T11:12:38.393Z","project":"5ecd911e605d8a005f87ad63","initVersion":"5ecd911e605d8a005f87ad69","__v":2,"effective_user":{"name":"Anuj","isAdmin":false},"vote_count":0,"id":"667d492636b67f004c912a51"},{"anonymous_user":{"name":"Laurence"},"algolia":{"recordCount":0,"publishPending":false,"updatedAt":"2025-01-21T04:24:01.810Z"},"title":"Looking for a developer familiar with Gorgias API (and Magento)","votes":0,"voters":[],"hub2voters":[],"views":99,"type":"question","solved":false,"body":"Looking to connect a Magento 2.3 store with Gorgias with widget. 2.3 version of official module not available in adobe marketplace.","searchContents":"Looking to connect a Magento 2.3 store with Gorgias with widget. 2.3 version of official module not available in adobe marketplace.","isSpam":false,"isFAQ":false,"edited":false,"comments":[],"tags":[],"revision":101,"_id":"666590cb059ddc006b3f9716","createdAt":"2024-06-09T11:23:55.494Z","updatedAt":"2024-06-09T11:23:55.494Z","project":"5ecd911e605d8a005f87ad63","initVersion":"5ecd911e605d8a005f87ad69","__v":0,"effective_user":{"name":"Laurence","isAdmin":false},"vote_count":0,"id":"666590cb059ddc006b3f9716"}],"docsCategories":[{"_id":"60b8f7a0c9b1e80079f6c135","title":"Introduction","slug":"introduction","order":2,"reference":false,"isAPI":false,"project":"5ecd911e605d8a005f87ad63","version":"5ecd911e605d8a005f87ad69","createdAt":"2021-06-03T15:39:12.827Z","__v":0,"pages":[{"_id":"6269c0109d3d22017b5f14ad","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Private vs. Public App","type":"basic","slug":"private-vs-public-app","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-04-27T22:13:36.447Z","category":"60b8f7a0c9b1e80079f6c135","parentDoc":null,"isBodyEmpty":false,"children":[]}]},{"_id":"5f29ed62afdb6902b28ece17","title":"Authentication","slug":"why-build-on-gorgias","order":3,"reference":false,"isAPI":false,"project":"5ecd911e605d8a005f87ad63","version":"5ecd911e605d8a005f87ad69","createdAt":"2020-08-04T23:21:06.987Z","__v":0,"pages":[{"_id":"6269c116021223005924e0b8","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Access Tokens (API Keys)","type":"basic","slug":"access-tokens-api-keys","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-04-27T22:17:58.555Z","category":"5f29ed62afdb6902b28ece17","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"6269c21812cbdb02fa1fa9a9","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"OAuth2 Bearer Token","type":"basic","slug":"oauth2-bearer-token","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-04-27T22:22:16.500Z","category":"5f29ed62afdb6902b28ece17","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"60ad5dab0327a20071bbeedb","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"OAuth2 Scopes","type":"basic","slug":"oauth2-scopes","order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-05-25T20:27:23.397Z","parentDoc":null,"category":"5f29ed62afdb6902b28ece17","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"6269c2f024af7a0170a822d4","title":"Building a Public App","slug":"building-public-app","order":4,"reference":false,"project":"5ecd911e605d8a005f87ad63","version":"5ecd911e605d8a005f87ad69","createdAt":"2022-04-27T22:25:52.510Z","__v":0,"pages":[{"_id":"6269c32079a10c00455505d7","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Overview","type":"basic","slug":"overview","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-04-27T22:26:40.921Z","category":"6269c2f024af7a0170a822d4","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"634754987200c807a4e9b4d3","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Building a high-quality Gorgias app","icon":"","type":"basic","slug":"building-a-high-quality-gorgias-app","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-10-12T23:58:16.933Z","category":"6269c2f024af7a0170a822d4","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"6269c36f148f2b002e7c7c9a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"1. Register on Developer Portal & Get Gorgias Sandbox Account","type":"basic","slug":"1-register-on-developer-portal","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-04-27T22:27:59.745Z","category":"6269c2f024af7a0170a822d4","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"6269c3c73352e500660b9397","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"2. Create a Draft App submission form","type":"basic","slug":"2-create-a-draft-app-submission-form","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-04-27T22:29:27.923Z","category":"6269c2f024af7a0170a822d4","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"609a93b4c9a828001631ef8a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"3. Set up OAuth2","type":"basic","slug":"set-up-oauth2-app-store","order":4,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-05-11T14:24:52.431Z","category":"6269c2f024af7a0170a822d4","parentDoc":null,"deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"6269c603a87796016374ff22","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"4. Build and test your app","type":"basic","slug":"4-build-and-test-your-app","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-04-27T22:38:59.931Z","category":"6269c2f024af7a0170a822d4","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"6269c618e6f97d006b7c5522","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"5. Submit app for review","type":"basic","slug":"5-submit-app-for-review","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-04-27T22:39:20.596Z","category":"6269c2f024af7a0170a822d4","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"6269c64b1fa61300205aa772","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"6. Stay in touch","type":"basic","slug":"6-stay-in-touch","order":7,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-04-27T22:40:11.861Z","category":"6269c2f024af7a0170a822d4","parentDoc":null,"isBodyEmpty":false,"children":[]}]},{"_id":"5f29ed6a99626a0025d8919b","title":"Tutorials","slug":"common-api-use-cases","order":5,"reference":false,"isAPI":false,"project":"5ecd911e605d8a005f87ad63","version":"5ecd911e605d8a005f87ad69","createdAt":"2020-08-04T23:21:14.091Z","__v":0,"pages":[{"_id":"63a591875c992f000fb2f8a6","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"OAuth2 authentication for creating apps with Gorgias","icon":"","type":"basic","slug":"oauth2-authentication-for-creating-apps-with-gorgias","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f29ed6a99626a0025d8919b","createdAt":"2022-12-23T11:31:19.848Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"63a4858756386000a7f9f3f1","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Create a ticket using API","icon":"","type":"basic","slug":"create-a-ticket-using-api","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f29ed6a99626a0025d8919b","createdAt":"2022-12-22T16:27:51.937Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"63a96f2bb4a3910017939850","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Create a new message in ticket via API","icon":"","type":"basic","slug":"create-a-new-message-in-ticket-via-api","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f29ed6a99626a0025d8919b","createdAt":"2022-12-26T09:53:47.314Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5f29ee6e6cf244030db10bf4","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Integrate with a new channel","type":"basic","slug":"receive-and-respond-to-tickets-from-a-third-party-app","order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2020-08-04T23:25:34.756Z","category":"5f29ed6a99626a0025d8919b","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"6001c9dd08dfc60081988090","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Create integrations and widgets","type":"basic","slug":"create-integrations-and-widgets-programmatically","order":4,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-integrations-and-widgets","createdAt":"2021-01-15T16:59:09.422Z","category":"5f29ed6a99626a0025d8919b","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"5f29ee3dd1026902dc1eee27","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Show 3rd-party data in tickets","type":"basic","slug":"display-third-party-data-within-tickets","order":5,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2020-08-04T23:24:45.093Z","category":"5f29ed6a99626a0025d8919b","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"63a59c126d754c0016608392","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Sync Gorgias data with a database","icon":"","type":"basic","slug":"sync-gorgias-data-with-a-database","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f29ed6a99626a0025d8919b","createdAt":"2022-12-23T12:16:18.334Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"6453af3402109402132c4480","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"How to attach Gorgias tracking data to Shopify Cart and Checkout attributes","icon":"","type":"basic","slug":"how-to-attach-gorgias-tracking-data-to-shopify-cart-and-checkout-attributes","order":9,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"enrich-shopify-cart-and-checkout-attributes-with-gorgias-data","category":"5f29ed6a99626a0025d8919b","createdAt":"2023-05-04T13:12:20.250Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"671a4c75b20811001097fa09","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Refresh Shopify Cart’s UI on Updates via Convert","icon":"","type":"basic","slug":"how-to-attach-gorgias-tracking-data-to-shopify-cart-and-checkout-attributes-copy","order":9,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":null,"category":"5f29ed6a99626a0025d8919b","createdAt":"2024-10-24T13:32:37.148Z","isBodyEmpty":false,"children":[]}]}],"refCategories":[{"_id":"5ed892b261e0040028e64a2f","title":"Gorgias API","slug":"core-resources","order":0,"reference":true,"isAPI":false,"project":"5ecd911e605d8a005f87ad63","version":"5ecd911e605d8a005f87ad69","createdAt":"2020-06-04T06:20:34.688Z","__v":0,"pages":[{"_id":"5f21c18cf292510868eb3139","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Introduction","type":"basic","slug":"introduction","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"introduction-1","createdAt":"2020-07-29T18:35:56.116Z","category":"5ed892b261e0040028e64a2f","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"5f21c197d74b1507abda5a1e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Authentication","type":"basic","slug":"authentication","order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"authentication-1","createdAt":"2020-07-29T18:36:07.755Z","category":"5ed892b261e0040028e64a2f","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"5f21c33187b083070ed0d1dd","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Requests","type":"basic","slug":"requests","order":2,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2020-07-29T18:42:57.372Z","category":"5ed892b261e0040028e64a2f","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5f21c1b5b8b12105e7f9ccb2","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Errors","type":"basic","slug":"errors","order":3,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"errors-1","createdAt":"2020-07-29T18:36:37.971Z","category":"5ed892b261e0040028e64a2f","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"5f21c276e8ddd707f9bfe09e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Pagination","type":"basic","slug":"pagination","order":4,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"pagination-1","createdAt":"2020-07-29T18:39:50.110Z","category":"5ed892b261e0040028e64a2f","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"5f21c24b40f912003d80e0e3","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Rate Limits","type":"basic","slug":"limitations","order":5,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"limitations-1","createdAt":"2020-07-29T18:39:07.412Z","category":"5ed892b261e0040028e64a2f","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]}]},{"_id":"5f21c0f730340d03af4c5117","title":"gorgias rest api","slug":"gorgias-rest-api","order":1,"reference":true,"isAPI":true,"project":"5ecd911e605d8a005f87ad63","version":"5ecd911e605d8a005f87ad69","createdAt":"2020-07-29T18:33:27.689Z","__v":0,"pages":[{"_id":"5f21c0f930340d03af4c5118","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Account","type":"basic","slug":"account","order":0,"isReference":true,"hidden":false,"sync_unique":"tag__Account","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-07-29T18:33:29.386Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"5f2debd0518476004432582d","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The Account object","type":"basic","slug":"the-account-object","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-08T00:03:28.876Z","parentDoc":"5f21c0f930340d03af4c5118","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae0c1","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve your account","icon":"","type":"endpoint","slug":"get-account","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-account","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.927Z","parentDoc":"5f21c0f930340d03af4c5118","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"671b92a58ad934002a7a0de0","mdx":{},"api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Create a setting","icon":"","type":"endpoint","slug":"create-account-setting","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"create-account-setting","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-10-25T12:44:21.659Z","parentDoc":"5f21c0f930340d03af4c5118","isBodyEmpty":true,"children":[]},{"_id":"671b92a58ad934002a7a0de1","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List settings","icon":"","type":"endpoint","slug":"list-account-settings","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-account-settings","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-10-25T12:44:21.660Z","parentDoc":"5f21c0f930340d03af4c5118","isBodyEmpty":true,"children":[]},{"_id":"671b92a58ad934002a7a0de2","mdx":{},"api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update a setting","icon":"","type":"endpoint","slug":"update-account-setting","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-account-setting","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-10-25T12:44:21.660Z","parentDoc":"5f21c0f930340d03af4c5118","isBodyEmpty":true,"children":[]}]},{"_id":"5f2de030ef4f2800338be13b","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Customers","type":"basic","slug":"customers","order":1,"isReference":true,"hidden":false,"sync_unique":"tag__Customers","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-07T23:13:52.563Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"5f2debd1059063026198b134","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"The Customer object","type":"basic","slug":"the-customer-object","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-08T00:03:29.860Z","parentDoc":"5f2de030ef4f2800338be13b","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"5f2debcf4dd7ad023cb9da72","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The CustomerChannel object","type":"basic","slug":"the-customerchannel-object","order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-08T00:03:27.819Z","parentDoc":"5f2de030ef4f2800338be13b","isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae0c2","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Create a customer","icon":"","type":"endpoint","slug":"create-customer","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"create-customer","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.927Z","parentDoc":"5f2de030ef4f2800338be13b","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0c4","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Delete customers","icon":"","type":"endpoint","slug":"delete-customers","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete-customers","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.928Z","parentDoc":"5f2de030ef4f2800338be13b","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0c3","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List customers","icon":"","type":"endpoint","slug":"list-customers","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-customers","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.928Z","parentDoc":"5f2de030ef4f2800338be13b","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0c7","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Delete a customer","icon":"","type":"endpoint","slug":"delete-customer","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete-customer","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.929Z","parentDoc":"5f2de030ef4f2800338be13b","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0c5","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve a customer","icon":"","type":"endpoint","slug":"get-customer","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-customer","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.928Z","parentDoc":"5f2de030ef4f2800338be13b","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0c6","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update a customer","icon":"","type":"endpoint","slug":"update-customer","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-customer","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.929Z","parentDoc":"5f2de030ef4f2800338be13b","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0c8","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Merge two customers","icon":"","type":"endpoint","slug":"merge-customers","order":8,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"merge-customers","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.930Z","parentDoc":"5f2de030ef4f2800338be13b","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0c9","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Set customer data","icon":"","type":"endpoint","slug":"update-customer-data","order":9,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-customer-data","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.930Z","parentDoc":"5f2de030ef4f2800338be13b","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6798e87692ae28006f8a73cb","mdx":{},"api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Delete customer field value","icon":"","type":"endpoint","slug":"delete-customer-custom-field-value","order":10,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete-customer-custom-field-value","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2025-01-28T14:23:50.295Z","parentDoc":"5f2de030ef4f2800338be13b","isBodyEmpty":true,"children":[]},{"_id":"6798e87692ae28006f8a73cc","mdx":{},"api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update customer field value","icon":"","type":"endpoint","slug":"update-customer-custom-field-value","order":11,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-customer-custom-field-value","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2025-01-28T14:23:50.295Z","parentDoc":"5f2de030ef4f2800338be13b","isBodyEmpty":true,"children":[]},{"_id":"6798e87692ae28006f8a73cd","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List customer field values","icon":"","type":"endpoint","slug":"list-customer-custom-fields-values","order":12,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-customer-custom-fields-values","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2025-01-28T14:23:50.296Z","parentDoc":"5f2de030ef4f2800338be13b","isBodyEmpty":true,"children":[]},{"_id":"6798e87692ae28006f8a73ce","mdx":{},"api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update customer fields values","icon":"","type":"endpoint","slug":"update-customer-custom-field-values","order":13,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-customer-custom-field-values","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2025-01-28T14:23:50.296Z","parentDoc":"5f2de030ef4f2800338be13b","isBodyEmpty":true,"children":[]}]},{"_id":"6435d54c3b18090510b068e4","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Custom Fields","icon":"","type":"basic","slug":"custom-fields","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Custom Fields","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2023-04-11T21:46:52.652Z","parentDoc":null,"mdx":{},"isBodyEmpty":true,"children":[{"_id":"6435d556687389007cd27db4","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The CustomField object","icon":"","type":"basic","slug":"the-customfield-object","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2023-04-11T21:47:02.517Z","parentDoc":"6435d54c3b18090510b068e4","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae0ca","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Create a custom field","icon":"","type":"endpoint","slug":"create-custom-field","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"create-custom-field","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.930Z","parentDoc":"6435d54c3b18090510b068e4","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0cb","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List custom fields","icon":"","type":"endpoint","slug":"list-custom-fields","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-custom-fields","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.931Z","parentDoc":"6435d54c3b18090510b068e4","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0cc","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Bulk update a list of custom fields","icon":"","type":"endpoint","slug":"update-custom-fields","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-custom-fields","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.931Z","parentDoc":"6435d54c3b18090510b068e4","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0cd","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve a custom field","icon":"","type":"endpoint","slug":"get-custom-field","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-custom-field","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.932Z","parentDoc":"6435d54c3b18090510b068e4","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0ce","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update a custom field","icon":"","type":"endpoint","slug":"update-custom-field","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-custom-field","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.932Z","parentDoc":"6435d54c3b18090510b068e4","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"5f21c0f930340d03af4c5119","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Events","type":"basic","slug":"events","order":3,"isReference":true,"hidden":false,"sync_unique":"tag__Events","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-07-29T18:33:29.388Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"5f2debd2ab1f9b00653aa560","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The Event object","type":"basic","slug":"the-event-object","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-08T00:03:30.896Z","parentDoc":"5f21c0f930340d03af4c5119","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae0d0","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve an event","icon":"","type":"endpoint","slug":"get-event","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-event","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.933Z","parentDoc":"5f21c0f930340d03af4c5119","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0cf","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List events","icon":"","type":"endpoint","slug":"list-events","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-events","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.933Z","parentDoc":"5f21c0f930340d03af4c5119","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"5f21c0f930340d03af4c511a","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Files","type":"basic","slug":"files","order":4,"isReference":true,"hidden":false,"sync_unique":"tag__Files","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-07-29T18:33:29.390Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"5f2debd37633f80232b394a5","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The File object","type":"basic","slug":"the-file-object","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-08T00:03:31.954Z","parentDoc":"5f21c0f930340d03af4c511a","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"5f21c0f930340d03af4c5132","api":{"method":"post","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116","results":{"codes":[]}},"title":"Upload files","type":"endpoint","slug":"post_api-upload","order":1,"isReference":true,"hidden":false,"sync_unique":"post_api-upload","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-07-29T18:33:29.841Z","parentDoc":"5f21c0f930340d03af4c511a","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0d1","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Download a file","icon":"","type":"endpoint","slug":"download-file","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"download-file","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.934Z","parentDoc":"5f21c0f930340d03af4c511a","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"6022d03173b57b001b69e6a8","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Integrations","type":"basic","slug":"integrations","order":5,"isReference":true,"hidden":false,"sync_unique":"tag__Integrations","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2021-02-09T18:10:57.885Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"60130fdc1716b601bb32f591","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The Integration object","type":"basic","slug":"the-integration-object","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2021-01-28T19:26:20.908Z","parentDoc":"6022d03173b57b001b69e6a8","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"67e4250e9158640018e15109","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"The TicketHttpIntegration object","icon":"","type":"basic","slug":"the-tickethttpintegration-object","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2025-03-26T16:02:22.621Z","parentDoc":"6022d03173b57b001b69e6a8","isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae0d2","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Create an integration","icon":"","type":"endpoint","slug":"create-integration","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"create-integration","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.935Z","parentDoc":"6022d03173b57b001b69e6a8","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0d3","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List integrations","icon":"","type":"endpoint","slug":"list-integrations","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-integrations","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.935Z","parentDoc":"6022d03173b57b001b69e6a8","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0d6","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Delete an integration","icon":"","type":"endpoint","slug":"delete-integration","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete-integration","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.937Z","parentDoc":"6022d03173b57b001b69e6a8","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0d4","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve an integration","icon":"","type":"endpoint","slug":"get-integration","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-integration","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.936Z","parentDoc":"6022d03173b57b001b69e6a8","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0d5","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update an integration","icon":"","type":"endpoint","slug":"update-integration","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-integration","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.936Z","parentDoc":"6022d03173b57b001b69e6a8","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"5f21c0f930340d03af4c511b","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Jobs","type":"basic","slug":"jobs","order":6,"isReference":true,"hidden":false,"sync_unique":"tag__Jobs","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-07-29T18:33:29.391Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"5f2debd491c43e019ec5bfbe","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The Job object","type":"basic","slug":"the-job-object","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-08T00:03:32.944Z","parentDoc":"5f21c0f930340d03af4c511b","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae0d7","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Create a job","icon":"","type":"endpoint","slug":"create-job","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"create-job","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.937Z","parentDoc":"5f21c0f930340d03af4c511b","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0d8","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List jobs","icon":"","type":"endpoint","slug":"list-jobs","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-jobs","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.937Z","parentDoc":"5f21c0f930340d03af4c511b","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0db","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Cancel a job","icon":"","type":"endpoint","slug":"cancel-job","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"cancel-job","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.939Z","parentDoc":"5f21c0f930340d03af4c511b","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0d9","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve a job","icon":"","type":"endpoint","slug":"get-job","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-job","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.938Z","parentDoc":"5f21c0f930340d03af4c511b","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0da","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update a job","icon":"","type":"endpoint","slug":"update-job","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-job","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.938Z","parentDoc":"5f21c0f930340d03af4c511b","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"5f21c0f930340d03af4c511c","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Macros","type":"basic","slug":"macros","order":7,"isReference":true,"hidden":false,"sync_unique":"tag__Macros","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-07-29T18:33:29.393Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"5f2debd630f2db002c8a7f81","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"The Macro object","type":"basic","slug":"the-macro-object","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-08T00:03:34.799Z","parentDoc":"5f21c0f930340d03af4c511c","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"5f2debd55c64bc02292f8e5e","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The MacroAction object","type":"basic","slug":"the-macroaction-object","order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-08T00:03:33.788Z","parentDoc":"5f21c0f930340d03af4c511c","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae0dc","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Create a macro","icon":"","type":"endpoint","slug":"create-macro","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"create-macro","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.939Z","parentDoc":"5f21c0f930340d03af4c511c","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0dd","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List macros","icon":"","type":"endpoint","slug":"list-macros","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-macros","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.940Z","parentDoc":"5f21c0f930340d03af4c511c","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0e0","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Delete a macro","icon":"","type":"endpoint","slug":"delete-macro","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete-macro","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.941Z","parentDoc":"5f21c0f930340d03af4c511c","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0de","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve a macro","icon":"","type":"endpoint","slug":"get-macro","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-macro","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.940Z","parentDoc":"5f21c0f930340d03af4c511c","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0df","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update a macro","icon":"","type":"endpoint","slug":"update-macro","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-macro","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.941Z","parentDoc":"5f21c0f930340d03af4c511c","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6798e87692ae28006f8a73cf","mdx":{},"api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Archive macros","icon":"","type":"endpoint","slug":"bulk-archive-macros","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"bulk-archive-macros","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2025-01-28T14:23:50.302Z","parentDoc":"5f21c0f930340d03af4c511c","isBodyEmpty":true,"children":[]},{"_id":"6798e87692ae28006f8a73d0","mdx":{},"api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Unarchive macros","icon":"","type":"endpoint","slug":"bulk-unarchive-macros","order":8,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"bulk-unarchive-macros","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2025-01-28T14:23:50.303Z","parentDoc":"5f21c0f930340d03af4c511c","isBodyEmpty":true,"children":[]}]},{"_id":"5f21c0f930340d03af4c511d","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Rules","type":"basic","slug":"rules","order":8,"isReference":true,"hidden":false,"sync_unique":"tag__Rules","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-07-29T18:33:29.394Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"5f2debd71207d10251cd3e27","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The Rule object","type":"basic","slug":"the-rule-object","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-08T00:03:35.957Z","parentDoc":"5f21c0f930340d03af4c511d","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae0e1","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Create a rule","icon":"","type":"endpoint","slug":"create-rule","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"create-rule","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.942Z","parentDoc":"5f21c0f930340d03af4c511d","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0e2","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List rules","icon":"","type":"endpoint","slug":"list-rules","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-rules","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.942Z","parentDoc":"5f21c0f930340d03af4c511d","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0e5","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Delete a rule","icon":"","type":"endpoint","slug":"delete-rule","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete-rule","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.944Z","parentDoc":"5f21c0f930340d03af4c511d","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0e3","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve a rule","icon":"","type":"endpoint","slug":"get-rule","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-rule","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.943Z","parentDoc":"5f21c0f930340d03af4c511d","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0e4","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update a rule","icon":"","type":"endpoint","slug":"update-rule","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-rule","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.943Z","parentDoc":"5f21c0f930340d03af4c511d","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0e6","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update rules' priorities","icon":"","type":"endpoint","slug":"update-rules-priorities","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-rules-priorities","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.945Z","parentDoc":"5f21c0f930340d03af4c511d","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"5f21c0f930340d03af4c511e","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Satisfaction Surveys","type":"basic","slug":"satisfaction-surveys","order":9,"isReference":true,"hidden":false,"sync_unique":"tag__Satisfaction Surveys","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-07-29T18:33:29.396Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"5f2debd8c1a8a702b8aa87e1","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The SatisfactionSurvey object","type":"basic","slug":"the-satisfactionsurvey-object","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-08T00:03:36.459Z","parentDoc":"5f21c0f930340d03af4c511e","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae0e7","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Create a survey","icon":"","type":"endpoint","slug":"create-satisfaction-survey","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"create-satisfaction-survey","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.946Z","parentDoc":"5f21c0f930340d03af4c511e","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0e8","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List surveys","icon":"","type":"endpoint","slug":"list-satisfaction-surveys","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-satisfaction-surveys","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.946Z","parentDoc":"5f21c0f930340d03af4c511e","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0e9","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve a survey","icon":"","type":"endpoint","slug":"get-satisfaction-survey","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-satisfaction-survey","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.947Z","parentDoc":"5f21c0f930340d03af4c511e","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0ea","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update a survey","icon":"","type":"endpoint","slug":"update-satisfaction-survey","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-satisfaction-survey","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.948Z","parentDoc":"5f21c0f930340d03af4c511e","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"5f21c0f930340d03af4c511f","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Search","type":"basic","slug":"search","order":10,"isReference":true,"hidden":false,"sync_unique":"tag__Search","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-07-29T18:33:29.397Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"6614d4479332850025fae0eb","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Search for resources","icon":"","type":"endpoint","slug":"search-1","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"search","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.949Z","parentDoc":"5f21c0f930340d03af4c511f","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"5f21c0f930340d03af4c5120","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Statistics","type":"basic","slug":"statistics","order":11,"isReference":true,"hidden":false,"sync_unique":"tag__Statistics","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-07-29T18:33:29.399Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"5f2debded9793b0012e64134","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"The Statistic object","type":"basic","slug":"the-statistic-object","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-08T00:03:42.062Z","parentDoc":"5f21c0f930340d03af4c5120","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"5f21c0f930340d03af4c5148","api":{"method":"post","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116","results":{"codes":[]}},"title":"Retrieve a statistic","type":"endpoint","slug":"post_api-stats-name","order":1,"isReference":true,"hidden":false,"sync_unique":"post_api-stats-name","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-07-29T18:33:29.928Z","parentDoc":"5f21c0f930340d03af4c5120","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"5f21c0f930340d03af4c5149","api":{"method":"post","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116","results":{"codes":[]}},"title":"Download a statistic","type":"endpoint","slug":"post_api-stats-name-download","order":2,"isReference":true,"hidden":false,"sync_unique":"post_api-stats-name-download","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-07-29T18:33:29.930Z","parentDoc":"5f21c0f930340d03af4c5120","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"5f21c0f930340d03af4c5122","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Tags","type":"basic","slug":"tags","order":12,"isReference":true,"hidden":false,"sync_unique":"tag__Tags","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-07-29T18:33:29.401Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"5f2debda1207d10251cd3e29","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The Tag object","type":"basic","slug":"the-tag-object","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-08T00:03:38.974Z","parentDoc":"5f21c0f930340d03af4c5122","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae0f6","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Create a tag","icon":"","type":"endpoint","slug":"create-tag","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"create-tag","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.957Z","parentDoc":"5f21c0f930340d03af4c5122","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0f8","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Delete tags","icon":"","type":"endpoint","slug":"delete-tags","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete-tags","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.959Z","parentDoc":"5f21c0f930340d03af4c5122","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0f7","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List tags","icon":"","type":"endpoint","slug":"list-tags","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-tags","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.958Z","parentDoc":"5f21c0f930340d03af4c5122","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0fb","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Delete a tag","icon":"","type":"endpoint","slug":"delete-tag","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete-tag","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.961Z","parentDoc":"5f21c0f930340d03af4c5122","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0f9","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve a tag","icon":"","type":"endpoint","slug":"get-tag","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-tag","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.960Z","parentDoc":"5f21c0f930340d03af4c5122","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0fa","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update a tag","icon":"","type":"endpoint","slug":"update-tag","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-tag","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.961Z","parentDoc":"5f21c0f930340d03af4c5122","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0fc","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Merge tags","icon":"","type":"endpoint","slug":"merge-tags","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"merge-tags","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.961Z","parentDoc":"5f21c0f930340d03af4c5122","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"62e7ee17cc158200a4fcbd19","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Teams","icon":"","type":"basic","slug":"teams","order":13,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Teams","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2022-08-01T15:15:35.361Z","parentDoc":null,"mdx":{},"isBodyEmpty":true,"children":[{"_id":"62e7ee20c38f2f005079523b","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The Team object","icon":"","type":"basic","slug":"the-team-object","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2022-08-01T15:15:44.269Z","parentDoc":"62e7ee17cc158200a4fcbd19","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae0f1","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Create a team","icon":"","type":"endpoint","slug":"create-team","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"create-team","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.954Z","parentDoc":"62e7ee17cc158200a4fcbd19","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0f2","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List teams","icon":"","type":"endpoint","slug":"list-teams","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-teams","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.954Z","parentDoc":"62e7ee17cc158200a4fcbd19","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0f5","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Delete a team","icon":"","type":"endpoint","slug":"delete-team","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete-team","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.957Z","parentDoc":"62e7ee17cc158200a4fcbd19","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0f3","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve a team","icon":"","type":"endpoint","slug":"get-team","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-team","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.955Z","parentDoc":"62e7ee17cc158200a4fcbd19","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0f4","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update a team","icon":"","type":"endpoint","slug":"update-team","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-team","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.956Z","parentDoc":"62e7ee17cc158200a4fcbd19","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"5f2de030ef4f2800338be13d","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Tickets","type":"basic","slug":"tickets","order":14,"isReference":true,"hidden":false,"sync_unique":"tag__Tickets","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-07T23:13:52.568Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"5f2debdce0605e0211422592","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The Ticket object","type":"basic","slug":"the-ticket-object","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-08T00:03:40.266Z","parentDoc":"5f2de030ef4f2800338be13d","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae0fd","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Create a ticket","icon":"","type":"endpoint","slug":"create-ticket","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"create-ticket","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.962Z","parentDoc":"5f2de030ef4f2800338be13d","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0fe","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List tickets","icon":"","type":"endpoint","slug":"list-tickets","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-tickets","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.962Z","parentDoc":"5f2de030ef4f2800338be13d","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae101","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Delete a ticket","icon":"","type":"endpoint","slug":"delete-ticket","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete-ticket","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.964Z","parentDoc":"5f2de030ef4f2800338be13d","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0ff","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve a ticket","icon":"","type":"endpoint","slug":"get-ticket","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-ticket","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.963Z","parentDoc":"5f2de030ef4f2800338be13d","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae100","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update a ticket","icon":"","type":"endpoint","slug":"update-ticket","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-ticket","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.963Z","parentDoc":"5f2de030ef4f2800338be13d","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae107","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Add ticket tags","icon":"","type":"endpoint","slug":"create-ticket-tags","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"create-ticket-tags","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.966Z","parentDoc":"5f2de030ef4f2800338be13d","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae109","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Remove ticket tags","icon":"","type":"endpoint","slug":"delete-ticket-tags","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete-ticket-tags","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.967Z","parentDoc":"5f2de030ef4f2800338be13d","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"627e6d585e093e0536085a47","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List ticket tags","type":"endpoint","slug":"get_api-tickets-ticket-id-tags","order":8,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_api-tickets-ticket-id-tags","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2022-05-13T14:38:16.432Z","parentDoc":"5f2de030ef4f2800338be13d","icon":"","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae108","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Set ticket tags","icon":"","type":"endpoint","slug":"update-ticket-tags","order":9,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-ticket-tags","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.967Z","parentDoc":"5f2de030ef4f2800338be13d","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae10d","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Delete ticket field value","icon":"","type":"endpoint","slug":"delete-ticket-custom-field","order":10,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete-ticket-custom-field","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.969Z","parentDoc":"5f2de030ef4f2800338be13d","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae10c","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update ticket field value","icon":"","type":"endpoint","slug":"update-ticket-custom-field","order":11,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-ticket-custom-field","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.968Z","parentDoc":"5f2de030ef4f2800338be13d","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae10a","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List ticket field values","icon":"","type":"endpoint","slug":"list-ticket-custom-fields","order":12,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-ticket-custom-fields","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.968Z","parentDoc":"5f2de030ef4f2800338be13d","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae10b","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update ticket fields values","icon":"","type":"endpoint","slug":"update-ticket-custom-fields","order":13,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-ticket-custom-fields","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.968Z","parentDoc":"5f2de030ef4f2800338be13d","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"5f2de030ef4f2800338be13e","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Ticket Messages","type":"basic","slug":"ticket-messages","order":15,"isReference":true,"hidden":false,"sync_unique":"tag__Ticket Messages","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-07T23:13:52.569Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"5f2debdd8c2e460273fac9d0","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The TicketMessage object","type":"basic","slug":"the-ticketmessage-object","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-08T00:03:41.049Z","parentDoc":"5f2de030ef4f2800338be13e","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae102","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Create a message","icon":"","type":"endpoint","slug":"create-ticket-message","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"create-ticket-message","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.964Z","parentDoc":"5f2de030ef4f2800338be13e","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae103","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List messages of a ticket","icon":"","type":"endpoint","slug":"list-ticket-messages","order":2,"isReference":true,"deprecated":true,"hidden":false,"sync_unique":"list-ticket-messages","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.965Z","parentDoc":"5f2de030ef4f2800338be13e","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae106","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Delete a message","icon":"","type":"endpoint","slug":"delete-ticket-message","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete-ticket-message","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.966Z","parentDoc":"5f2de030ef4f2800338be13e","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae104","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve a message","icon":"","type":"endpoint","slug":"get-ticket-message","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-ticket-message","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.965Z","parentDoc":"5f2de030ef4f2800338be13e","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae105","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update a message","icon":"","type":"endpoint","slug":"update-ticket-message","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-ticket-message","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.965Z","parentDoc":"5f2de030ef4f2800338be13e","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae10e","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List messages","icon":"","type":"endpoint","slug":"list-messages","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-messages","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.969Z","parentDoc":"5f2de030ef4f2800338be13e","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"5f2de030ef4f2800338be13c","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Users","type":"basic","slug":"users","order":16,"isReference":true,"hidden":false,"sync_unique":"tag__Users","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-07T23:13:52.567Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"5f2debd8e49d45002f231493","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The User object","type":"basic","slug":"the-user-object","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-08T00:03:36.958Z","parentDoc":"5f2de030ef4f2800338be13c","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae0ec","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Create a user","icon":"","type":"endpoint","slug":"create-user","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"create-user","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.950Z","parentDoc":"5f2de030ef4f2800338be13c","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0ed","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List users","icon":"","type":"endpoint","slug":"list-users","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-users","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.950Z","parentDoc":"5f2de030ef4f2800338be13c","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0f0","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Delete a user","icon":"","type":"endpoint","slug":"delete-user","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete-user","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.953Z","parentDoc":"5f2de030ef4f2800338be13c","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0ee","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve a user","icon":"","type":"endpoint","slug":"get-user","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-user","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.951Z","parentDoc":"5f2de030ef4f2800338be13c","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae0ef","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update a user","icon":"","type":"endpoint","slug":"update-user","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-user","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.952Z","parentDoc":"5f2de030ef4f2800338be13c","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"5f21c0f930340d03af4c5121","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Views","type":"basic","slug":"views","order":17,"isReference":true,"hidden":false,"sync_unique":"tag__Views","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-07-29T18:33:29.400Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"5f2debdfffaf85017fcd6640","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The View object","type":"basic","slug":"the-view-object","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2020-08-08T00:03:43.144Z","parentDoc":"5f21c0f930340d03af4c5121","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae10f","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Create a view","icon":"","type":"endpoint","slug":"create-view","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"create-view","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.970Z","parentDoc":"5f21c0f930340d03af4c5121","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae110","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List views","icon":"","type":"endpoint","slug":"list-views","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-views","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.971Z","parentDoc":"5f21c0f930340d03af4c5121","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae113","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Delete a view","icon":"","type":"endpoint","slug":"delete-view","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete-view","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.972Z","parentDoc":"5f21c0f930340d03af4c5121","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae111","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve a view","icon":"","type":"endpoint","slug":"get-view","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-view","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.971Z","parentDoc":"5f21c0f930340d03af4c5121","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae112","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update a view","icon":"","type":"endpoint","slug":"update-view","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-view","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.971Z","parentDoc":"5f21c0f930340d03af4c5121","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae114","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List view's items","icon":"","type":"endpoint","slug":"list-view-items","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-view-items","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.973Z","parentDoc":"5f21c0f930340d03af4c5121","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae115","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Search for view's items","icon":"","type":"endpoint","slug":"update-view-items","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-view-items","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.973Z","parentDoc":"5f21c0f930340d03af4c5121","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"64958146cacc9a000bb4dca0","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Voice Calls","icon":"","type":"basic","slug":"voice-calls","order":18,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Voice Calls","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2023-06-23T11:25:58.388Z","parentDoc":null,"mdx":{},"isBodyEmpty":true,"children":[{"_id":"64f5e40a0d548b00434a9cd7","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The VoiceCall object","icon":"","type":"basic","slug":"the-voicecall-object","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2023-09-04T14:04:58.606Z","parentDoc":"64958146cacc9a000bb4dca0","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae117","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve a voice call","icon":"","type":"endpoint","slug":"get-voice-call","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-voice-call","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.975Z","parentDoc":"64958146cacc9a000bb4dca0","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae116","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List voice calls","icon":"","type":"endpoint","slug":"list-voice-calls","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-voice-calls","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.974Z","parentDoc":"64958146cacc9a000bb4dca0","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"64958146cacc9a000bb4dca1","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Voice Call Recordings","icon":"","type":"basic","slug":"voice-call-recordings","order":19,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Voice Call Recordings","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2023-06-23T11:25:58.388Z","parentDoc":null,"mdx":{},"isBodyEmpty":true,"children":[{"_id":"64f5e40bd84c6d006d37680d","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The VoiceCallRecording object","icon":"","type":"basic","slug":"the-voicecallrecording-object","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2023-09-04T14:04:59.136Z","parentDoc":"64958146cacc9a000bb4dca1","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae11a","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Delete a voice call recording","icon":"","type":"endpoint","slug":"delete-voice-call-recording","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete-voice-call-recording","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.977Z","parentDoc":"64958146cacc9a000bb4dca1","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae119","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve a voice call recording","icon":"","type":"endpoint","slug":"get-voice-call-recording","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-voice-call-recording","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.976Z","parentDoc":"64958146cacc9a000bb4dca1","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae118","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List voice call recordings","icon":"","type":"endpoint","slug":"list-voice-call-recordings","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-voice-call-recordings","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.976Z","parentDoc":"64958146cacc9a000bb4dca1","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"64ef0c350b0f9d0bd9bed753","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Voice Call Events","icon":"","type":"basic","slug":"voice-call-events","order":20,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Voice Call Events","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2023-08-30T09:30:29.509Z","parentDoc":null,"mdx":{},"isBodyEmpty":true,"children":[{"_id":"64f5e40b10083500407a0803","api":{"method":"get","url":"","auth":"required","params":[]},"title":"The VoiceCallEvent object","icon":"","type":"basic","slug":"the-voicecallevent-object","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2023-09-04T14:04:59.498Z","parentDoc":"64ef0c350b0f9d0bd9bed753","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae11c","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve a voice call event","icon":"","type":"endpoint","slug":"get-voice-call-event","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-voice-call-event","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.978Z","parentDoc":"64ef0c350b0f9d0bd9bed753","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae11b","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List voice call events","icon":"","type":"endpoint","slug":"list-voice-call-events","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-voice-call-events","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.978Z","parentDoc":"64ef0c350b0f9d0bd9bed753","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"6005e1a0ec3fce00378f9bdd","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Widgets","type":"basic","slug":"widgets","order":21,"isReference":true,"hidden":false,"sync_unique":"tag__Widgets","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2021-01-18T19:29:36.285Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"6005e1a7814c540081e47576","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"The Widget object","type":"basic","slug":"the-widget-object","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2021-01-18T19:29:43.744Z","parentDoc":"6005e1a0ec3fce00378f9bdd","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6614d4479332850025fae11d","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Create a widget","icon":"","type":"endpoint","slug":"create-widget","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"create-widget","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.979Z","parentDoc":"6005e1a0ec3fce00378f9bdd","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae11e","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"List widgets","icon":"","type":"endpoint","slug":"list-widgets","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"list-widgets","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.980Z","parentDoc":"6005e1a0ec3fce00378f9bdd","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae121","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Delete a widget","icon":"","type":"endpoint","slug":"delete-widget","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete-widget","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.981Z","parentDoc":"6005e1a0ec3fce00378f9bdd","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae11f","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Retrieve a widget","icon":"","type":"endpoint","slug":"get-widget","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get-widget","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.980Z","parentDoc":"6005e1a0ec3fce00378f9bdd","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6614d4479332850025fae120","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"5f21c0f730340d03af4c5116"},"title":"Update a widget","icon":"","type":"endpoint","slug":"update-widget","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"update-widget","link_url":"","link_external":false,"previousSlug":"","category":"5f21c0f730340d03af4c5117","createdAt":"2024-04-09T05:38:15.981Z","parentDoc":"6005e1a0ec3fce00378f9bdd","mdx":{},"isBodyEmpty":true,"children":[]}]}]}],"meta":{"title":"gorgias-developers","type":"home"},"config":{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"dc8065a65ef83d6ad23e37aaf014fc84","enabled":true},"asset_url":"https://cdn.readme.io","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2025-03-27","fullstory":{"enabled":true,"orgId":"FSV9A"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.323.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true,"tracesSampleRate":0},"shMigration":{"promoVideo":"","forceWaitlist":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}},"context":{"labs":{},"user":{},"terms":[{"_id":"5eea87ff7726d50060bbe15f","term":"Ticket","definition":"A ticket is a conversation with a customer, on any channel. It can be on email, phone, chat, etc."}],"variables":{"user":{},"defaults":[{"source":"","type":"","_id":"5ef3c9986e72a50012bcfe50","name":"domain","default":"my-domain"},{"source":"security","type":"http","_id":"67ab7bb4ff9e43002a85b664","name":"basicAuth","scheme":"basic","apiSetting":"6278eb1830673301a650d84c"}]},"project":{"_id":"5ecd911e605d8a005f87ad63","appearance":{"rdmd":{"callouts":{"useIconFont":false},"theme":{"background":"","border":"","markdownEdge":"","markdownFont":"","markdownFontSize":"","markdownLineHeight":"","markdownRadius":"","markdownText":"","markdownTitle":"","markdownTitleFont":"","mdCodeBackground":"","mdCodeFont":"","mdCodeRadius":"","mdCodeTabs":"","mdCodeText":"","tableEdges":"","tableHead":"","tableHeadText":"","tableRow":"","tableStripe":"","tableText":"","text":"","title":""}},"main_body":{"type":"links"},"colors":{"highlight":"","main":"#242F8C","main_alt":"","header_text":"","body_highlight":"#0075FF","custom_login_link_color":""},"typography":{"headline":"Open+Sans:400:sans-serif","body":"Open+Sans:400:sans-serif","typekit":false,"tk_key":"","tk_headline":"","tk_body":""},"header":{"style":"custom","img":["https://files.readme.io/14e37b9-hero.png","14e37b9-hero.png",2880,600,"#000000","660330042981d4003de2c557"],"img_size":"cover","img_pos":"tc"},"body":{"style":"none"},"global_landing_page":{"html":"","redirect":""},"referenceLayout":"column","link_logo_to_url":false,"theme":"solid","overlay":"triangles","landing":true,"sticky":false,"hide_logo":false,"childrenAsPills":false,"splitReferenceDocs":false,"logo":["https://files.readme.io/e509c23-5e693ac1927efe8a51c9662b_logo-gorgias.svg","5e693ac1927efe8a51c9662b_logo-gorgias.svg",175,40,"#161616"],"logo_white":["https://files.readme.io/d4ae1cd-gorgias_dark.svg","gorgias dark.svg",251,60,"#fff9f4"],"logo_white_use":true,"favicon":["https://files.readme.io/e0504de-small-blue_logo.png","blue logo.png",32,32,"#2a8bff","https://files.readme.io/076a823-blue_logo.png"],"stylesheet":"","stylesheet_hub2":"/* hide responses definitions in the sidebar */\n.hub-reference-response-definitions {\n display: none !important;\n}\n\n.react-json-view {\n font-family: Monaco,lucida console,monospace !important;\n padding: 0 !important;\n letter-spacing: 0 !important;\n}\n\n.react-json-view .variable-row {\n padding-top: 0 !important;\n padding-bottom: 0 !important;\n}\n.react-json-view .object-key {\n color: #e8e8e8 !important;\n letter-spacing: inherit !important;\n}\n.react-json-view .variable-value > div {\n color: #dd925f !important;\n}\n.react-json-view .expanded-icon > svg,\n.react-json-view .collapsed-icon > svg {\n\tcolor: #6c8eef!important;\n}\n.react-json-view .array-key {\n color: #d7a3ff !important;\n}\n.react-json-view .string-value {\n color: #b5bc67 !important;\n}\n.react-json-view .node-ellipsis {\n\tfont-size: inherit !important;\n}","javascript":"","javascript_hub2":"","html_promo":"<div class=\"undefined container\"><section class=\"LandingPageHeader20SNhBZ58Jy5 rm-LandingPageHeader\"><h1 class=\"LandingPageHeader-title16RMwPkp2O2W\">Developer Documentation</h1><div class=\"markdown-body LandingPageHeader-text3zJOEVqnHdlf\" data-testid=\"RDMD\"><p>Explore our guides and technical documentation to integrate with Gorgias.</p></div><div align=\"center\" justify=\"start\" layout=\"row\" tag=\"div\" class=\"Flex Flex_row \" style=\"--flex-gap:var(--md)\"><a class=\"Button Button_md LandingPageHeader-button_primaryLpo1zn3KXh20\" href=\"https://partners.gorgias.com/login\" target=\"_blank\"><i class=\"icon- \"></i><span>Start Building</span></a><a class=\"Button Button_md LandingPageHeader-button_secondary3s2XpkqwCz8B\" href=\"https://www.gorgias.com/apps\" target=\"_blank\"><i class=\"icon-app-store\"></i><span>Visit App Store</span></a></div></section></div>","html_body":"","html_footer":"","html_head":"","html_footer_meta":"<script>\n window.setTimeout(() => {\n let typeFormScript = document.createElement('script');\n typeFormScript.setAttribute('src','//embed.typeform.com/next/embed.js');\n document.head.appendChild(typeFormScript);\n }, 2000);\n</script>\n\n<!--Gorgias Chat Widget Start-->\n<script id=\"gorgias-chat-widget-install-v2\" src=\"https://config.gorgias.chat/gorgias-chat-bundle-loader.js?applicationId=16724\"></script>\n<!--Gorgias Chat Widget End-->\n\n<div class=\"powr-popup\" id=\"d7e537b7_1655157718\"></div><script src=\"https://www.powr.io/powr.js?platform=shopify\"></script>","html_hidelinks":false,"showVersion":false,"hideTableOfContents":false,"nextStepsLabel":"","promos":[{"extras":{"type":"html","buttonPrimary":"get-started","buttonSecondary":"reference"},"title":"","text":"","_id":"5ecd911e605d8a005f87ad64"}],"subheaderStyle":"links","showMetricsInReference":true,"referenceSimpleMode":true,"stylesheet_hub3":"","loginLogo":[],"logo_large":false,"colorScheme":"system","changelog":{"layoutExpanded":false,"showAuthor":true,"showExactDate":false},"allowApiExplorerJsonEditor":false},"custom_domain":"developers.gorgias.com","childrenProjects":[],"derivedPlan":"business-annual-2024","description":"Gorgias Developer Portal. REST API reference and Guides.","error404":"","experiments":[],"first_page":"landing","flags":{"allowXFrame":false,"allow_hub2":false,"alwaysShowDocPublishStatus":false,"cookieAuthentication":false,"correctnewlines":false,"directGoogleToStableVersion":false,"disableAnonForum":false,"enterprise":false,"hideGoogleAnalytics":false,"hub2":true,"migrationRun":false,"migrationSwaggerRun":false,"newApiExplorer":true,"newEditor":true,"newMarkdownBetaProgram":true,"newSearch":true,"oauth":false,"oldMarkdown":false,"rdmdCompatibilityMode":false,"speedyRender":false,"staging":false,"swagger":false,"translation":false,"tutorials":true,"allowApiExplorerJsonEditor":false,"useReactApp":true,"newHeader":false,"referenceRedesign":false,"auth0Oauth":false,"graphql":false,"singleProjectEnterprise":false,"dashReact":false,"allowReferenceUpgrade":true,"metricsV2":true,"newEditorDash":true,"enableRealtimeExperiences":false,"reviewWorkflow":true,"star":false,"allowDarkMode":false,"forceDarkMode":false,"useReactGLP":false,"disablePasswordlessLogin":false,"personalizedDocs":false,"myDevelopers":false,"superHub":false,"developerDashboard":false,"allowReusableOTPs":false,"dashHomeRefresh":false,"owlbotAi":false,"apiV2":false,"git":{"read":false,"write":false},"superHubBeta":false,"dashQuickstart":false,"disableAutoTranslate":false,"customBlocks":false,"devDashHub":false,"disableSAMLScoping":false,"allowUnsafeCustomHtmlSuggestionsFromNonAdmins":false,"apiAccessRevoked":false,"passwordlessLogin":"default","disableSignups":false,"billingRedesignEnabled":true,"developerPortal":false,"mdx":false,"superHubDevelopment":false,"annualBillingEnabled":true,"devDashBillingRedesignEnabled":false,"enableOidc":false,"customComponents":false,"disableDiscussionSpamRecaptchaBypass":false,"developerViewUsersData":false,"changelogRssAlwaysPublic":false,"bidiSync":false,"superHubMigrationSelfServeFlow":true,"apiDesigner":false,"hideEnforceSSO":false,"localLLM":false,"superHubManageVersions":false,"gitSidebar":false,"superHubGlobalCustomBlocks":false,"childManagedBidi":false},"fullBaseUrl":"https://developers.gorgias.com/","git":{"migration":{"createRepository":{},"transformation":{},"migratingPages":{},"enableSuperhub":{}},"sync":{"linked_repository":{},"installationRequest":{},"connections":[],"providers":[]}},"glossaryTerms":[{"_id":"5eea87ff7726d50060bbe15f","term":"Ticket","definition":"A ticket is a conversation with a customer, on any channel. It can be on email, phone, chat, etc."}],"graphqlSchema":"","gracePeriod":{"enabled":false,"endsAt":null},"shouldGateDash":false,"healthCheck":{"provider":"statusPage","settings":{"page":"2lqy3hys4460","status":false,"url":""}},"intercom_secure_emailonly":false,"intercom":"","is_active":true,"integrations":{"login":{}},"internal":"","jwtExpirationTime":0,"landing_bottom":[{"type":"text","alignment":"left","title":"Start Building on Gorgias Today","text":"Integrate with Gorgias to support thousands of shop owners and grow your app audience. Or simply build a private app to empower your support team with the tools they need. Regardless of your end goal, follow these easy steps below to build an integration with us."},{"type":"html","alignment":"left","html":"<div class=\"LandingBlock3PM-HyBxby3X LandingBlock-Three2lm6yBrv1MlV LandingBlock_align=leftG1r7ROyW_AGB\"><div class=\"LandingBlock3PM-HyBxby3X\"><div class=\"markdown-body\" data-testid=\"RDMD\"><h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"-join-developer-portal\"></div><div class=\"heading-text\"><div id=\"section-🤖-join-developer-portal\" class=\"heading-anchor_backwardsCompatibility\"></div>🤖 1. Join Developer Portal</div><a aria-label=\"Skip link to 🤖 Join Developer Portal\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#-join-developer-portal\"></a></h2>\n<p>Sign up for our <a href=\"https://partners.gorgias.com/signup\" target=\"_blank\">Developer Portal</a> to start our partnership. This step is required only if you plan to build a Public app.</p></div></div><div class=\"LandingBlock3PM-HyBxby3X\"><div class=\"markdown-body\" data-testid=\"RDMD\"><h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"-build-your-app\"></div><div class=\"heading-text\"><div id=\"section-🚧-build-your-app\" class=\"heading-anchor_backwardsCompatibility\"></div>🚧 2. Build your app</div><a aria-label=\"Skip link to 🚧 Build your app\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#-build-your-app\"></a></h2>\n<p>Refer to our <a href=\"https://developers.gorgias.com/reference/introduction\" target=\"_blank\">API documentation</a> to find all the information you need.</p></div></div><div class=\"LandingBlock3PM-HyBxby3X\"><div class=\"markdown-body\" data-testid=\"RDMD\"><h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"-submit-your-app\"></div><div class=\"heading-text\"><div id=\"section-🚀-submit-your-app\" class=\"heading-anchor_backwardsCompatibility\"></div>🚀 3. Submit your app</div><a aria-label=\"Skip link to 🚀 Submit your app\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#-submit-your-app\"></a></h2>\n<p>We'll review it and let you know once it's approved and ready to be published in <a href=\"https://www.gorgias.com/apps\" target=\"_blank\">our App Store</a>. For Private apps there is no need for approval. Go ahead and use it!</p></div></div></div>"},{"type":"html","alignment":"left","html":"<div class=\"markdown-body\" data-testid=\"RDMD\"><h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"start-building-on-gorgias-today\"></div><div class=\"heading-text\"><div id=\"section-start-building-on-gorgias-today\" class=\"heading-anchor_backwardsCompatibility\"></div>🗞 Sign up for Developer Newsletter</div><a aria-label=\"Developer Newsletter\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#developer-newsletter\"></a></h2>\n<p>Sign up for our monthly developer newsletter. <br>It contains important updates about upcoming and breaking changes to the API.</p>\n<button data-tf-popup=\"aYWisghU\" data-tf-size=\"50\" data-tf-iframe-props=\"title=DevRel - Newsletter signup\" data-tf-medium=\"snippet\" style=\"all:unset;font-family:Helvetica,Arial,sans-serif;display:inline-block;max-width:100%;white-space:nowrap;overflow:hidden;text-overflow:ellipsis;background-color:#0075FF;color:#FFFFFF;font-size:14px;border-radius:4px;padding:0 23px;font-weight:bold;height:35px;cursor:pointer;line-height:35px;text-align:center;margin:0;text-decoration:none;\">Sign Up</button></div>"}],"mdxMigrationStatus":"rdmd","metrics":{"monthlyLimit":0,"thumbsEnabled":true,"planLimit":1000000,"realtime":{"dashEnabled":false,"hubEnabled":false},"monthlyPurchaseLimit":0,"meteredBilling":{}},"modules":{"landing":true,"docs":true,"examples":true,"reference":true,"changelog":true,"discuss":false,"suggested_edits":true,"logs":false,"custompages":true,"tutorials":false,"graphql":false},"name":"gorgias-developers","nav_names":{"docs":"Quickstart","reference":"","changelog":"","discuss":"","tutorials":"","recipes":""},"oauth_url":"","onboardingCompleted":{"api":true,"documentation":true,"jwt":true,"appearance":true,"domain":false,"logs":true,"metricsSDK":false},"owlbot":{"enabled":false,"isPaying":false,"customization":{"answerLength":"long","customTone":"","defaultAnswer":"","forbiddenWords":"","tone":"neutral"},"lastIndexed":"2024-03-28T19:32:06.585Z","copilot":{"enabled":false,"hasBeenUsed":false,"installedCustomPage":""}},"owner":{"id":null,"email":null,"name":null},"plan":"business-annual-2024","planOverride":"","planSchedule":{"stripeScheduleId":null,"changeDate":null,"nextPlan":null},"planStatus":"active","planTrial":"business-annual-2024","readmeScore":{"components":{"newDesign":{"enabled":true,"points":25},"reference":{"enabled":true,"points":50},"tryItNow":{"enabled":true,"points":35},"syncingOAS":{"enabled":true,"points":10},"customLogin":{"enabled":true,"points":25},"metrics":{"enabled":false,"points":40},"recipes":{"enabled":false,"points":15},"pageVoting":{"enabled":true,"points":1},"suggestedEdits":{"enabled":true,"points":10},"support":{"enabled":false,"points":5},"htmlLanding":{"enabled":true,"points":5},"guides":{"enabled":true,"points":10},"changelog":{"enabled":true,"points":5},"glossary":{"enabled":false,"points":1},"variables":{"enabled":true,"points":1},"integrations":{"enabled":true,"points":2}},"percentScore":50,"totalScore":179},"reCaptchaSiteKey":"6Le3ebYpAAAAAI649QQc7uink1u90Th7j6HtZpCm","reference":{"alwaysUseDefaults":true,"defaultExpandResponseExample":false,"defaultExpandResponseSchema":false,"enableOAuthFlows":false},"seo":{"overwrite_title_tag":false},"stable":{"_id":"5ecd911e605d8a005f87ad69","version":"1.0","version_clean":"1.0.0","codename":"Gorgias","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5ecd911e605d8a005f87ad6b","5f29ed62afdb6902b28ece17","5f29ed6a99626a0025d8919b","5f29ed9e6bbb610144c7a102","5f29edec08942f02f7851da1","5f2c359d691fb808de12f49d","60b8f7a0c9b1e80079f6c135","6269c2f024af7a0170a822d4","6376b49e2ac94400030a7fd8"],"project":"5ecd911e605d8a005f87ad63","releaseDate":"2020-05-26T21:58:54.164Z","createdAt":"2020-05-26T21:58:54.164Z","__v":7},"subdomain":"gorgias-developers","subpath":"","superHubWaitlist":false,"topnav":{"left":[],"right":[],"edited":true,"bottom":[]},"trial":{"trialDeadlineEnabled":true,"trialEndsAt":"2020-06-17T21:58:54.100Z"},"translate":{"provider":"transifex","show_widget":false,"key_public":"","org_name":"","project_name":"","languages":[]},"url":"https://www.gorgias.com","versions":[{"_id":"5f247f220bac320012988a6d","version":"0.1","version_clean":"0.1.0","codename":"Louis","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5f247f220bac320012988a2d","6376b49e2ac94400030a7fda"],"project":"5ecd911e605d8a005f87ad63","releaseDate":"2020-05-26T21:58:54.164Z","createdAt":"2020-05-26T21:58:54.164Z","__v":0,"forked_from":"5ecd911e605d8a005f87ad69"},{"_id":"6368f572910e31007756680c","version":"0.2","version_clean":"0.2.0","codename":"Mateusz","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":false,"categories":["5ecd911e605d8a005f87ad6b","6368f572910e31007756677a","6368f572910e31007756677b","5f29ed9e6bbb610144c7a102","5f29edec08942f02f7851da1","5f2c359d691fb808de12f49d","6368f572910e31007756677c","6368f572910e31007756677d","6376b49e2ac94400030a7fdb"],"project":"5ecd911e605d8a005f87ad63","releaseDate":"2020-05-26T21:58:54.164Z","createdAt":"2020-05-26T21:58:54.164Z","__v":0,"forked_from":"5ecd911e605d8a005f87ad69"},{"_id":"642166d5cec2a4001e9d20fc","version":"0.3","version_clean":"0.3.0","codename":"simobasso","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":false,"categories":["5ecd911e605d8a005f87ad6b","642166d4cec2a4001e9d2064","642166d4cec2a4001e9d2065","5f29ed9e6bbb610144c7a102","5f29edec08942f02f7851da1","5f2c359d691fb808de12f49d","642166d4cec2a4001e9d2066","642166d4cec2a4001e9d2067","6376b49e2ac94400030a7fd8","642166d5cec2a4001e9d20fe"],"project":"5ecd911e605d8a005f87ad63","releaseDate":"2020-05-26T21:58:54.164Z","createdAt":"2020-05-26T21:58:54.164Z","__v":0,"forked_from":"5ecd911e605d8a005f87ad69"},{"_id":"624f5a1531df17004b2b966b","version":"0.4","version_clean":"0.4.0","codename":"Samy","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":false,"categories":["5ecd911e605d8a005f87ad6b","624f5a1531df17004b2b95e7","624f5a1531df17004b2b95e8","5f29ed9e6bbb610144c7a102","5f29edec08942f02f7851da1","5f2c359d691fb808de12f49d","624f5a1531df17004b2b95e9","6376b49e2ac94400030a7fd9"],"project":"5ecd911e605d8a005f87ad63","releaseDate":"2020-05-26T21:58:54.164Z","createdAt":"2020-05-26T21:58:54.164Z","__v":0,"forked_from":"5ecd911e605d8a005f87ad69"},{"_id":"5f220adb8eba1e00668a8062","version":"0.5","version_clean":"0.5.0","codename":"Jean","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":false,"categories":["5f220adb8eba1e00668a8022","5ffeed2d8dff5c0025220b5c","5ffeedc5384796007c2a114b","6376b49e2ac94400030a7fd5"],"project":"5ecd911e605d8a005f87ad63","releaseDate":"2020-05-26T21:58:54.164Z","createdAt":"2020-05-26T21:58:54.164Z","__v":0,"forked_from":"5ecd911e605d8a005f87ad69"},{"_id":"6278eb1830673301a650d8d0","version":"0.6","version_clean":"0.6.0","codename":"Nicolas","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":false,"categories":["5ecd911e605d8a005f87ad6b","6278eb1830673301a650d848","6278eb1830673301a650d849","5f29ed9e6bbb610144c7a102","5f29edec08942f02f7851da1","5f2c359d691fb808de12f49d","6278eb1830673301a650d84a","6278eb1830673301a650d84b","6376b49e2ac94400030a7fd6","6377b2fbe3d1be0010f86b60","67e557923b240d0621becb86","67e55b628409800030223862","67e5660c913fae001ed69c9d","67e5669602b65600462e9b85"],"project":"5ecd911e605d8a005f87ad63","releaseDate":"2020-05-26T21:58:54.164Z","createdAt":"2020-05-26T21:58:54.164Z","__v":1,"forked_from":"5ecd911e605d8a005f87ad69","updatedAt":"2025-03-27T14:54:14.903Z"},{"_id":"615d93c58ab90600574c5f01","version":"0.7","version_clean":"0.7.0","codename":"Jan","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":false,"categories":["5ecd911e605d8a005f87ad6b","615d93c58ab90600574c5e7e","615d93c58ab90600574c5e7f","5f29ed9e6bbb610144c7a102","5f29edec08942f02f7851da1","5f2c359d691fb808de12f49d","615d93c58ab90600574c5e80","615ea5da9e444c0010a21443","61600b7602e81b0032f9eb72","61600bf3cd0efd0042e863a1","6376b49e2ac94400030a7fdc"],"project":"5ecd911e605d8a005f87ad63","releaseDate":"2020-05-26T21:58:54.164Z","createdAt":"2020-05-26T21:58:54.164Z","__v":3,"forked_from":"5ecd911e605d8a005f87ad69"},{"_id":"63ecee8959f8450053da81f6","version":"0.8","version_clean":"0.8.0","codename":"Wini","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":false,"categories":["5ecd911e605d8a005f87ad6b","63ecee8959f8450053da8160","63ecee8959f8450053da8161","5f29ed9e6bbb610144c7a102","5f29edec08942f02f7851da1","5f2c359d691fb808de12f49d","63ecee8959f8450053da8162","63ecee8959f8450053da8163","6376b49e2ac94400030a7fd8","63ecee8959f8450053da81f8"],"project":"5ecd911e605d8a005f87ad63","releaseDate":"2020-05-26T21:58:54.164Z","createdAt":"2020-05-26T21:58:54.164Z","__v":2,"forked_from":"5ecd911e605d8a005f87ad69"},{"_id":"655e08ba3ddac706e7fee576","version":"0.13","version_clean":"0.13.0","codename":"Catalin","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5ecd911e605d8a005f87ad6b","655e08ba3ddac706e7fee4c4","655e08ba3ddac706e7fee4c5","5f29ed9e6bbb610144c7a102","5f29edec08942f02f7851da1","5f2c359d691fb808de12f49d","655e08ba3ddac706e7fee4c6","655e08ba3ddac706e7fee4c7","6376b49e2ac94400030a7fd8","655e08bc3ddac706e7fee578"],"project":"5ecd911e605d8a005f87ad63","releaseDate":"2020-05-26T21:58:54.164Z","createdAt":"2023-11-22T13:57:14.169Z","__v":0,"forked_from":"5ecd911e605d8a005f87ad69","updatedAt":"2023-11-29T17:24:14.753Z"},{"_id":"6729dcac4125020011e0fa56","version":"0.14","version_clean":"0.14.0","codename":"anddon","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":false,"categories":["5ecd911e605d8a005f87ad6b","6729dcac4125020011e0f99a","6729dcac4125020011e0f99b","5f29ed9e6bbb610144c7a102","5f29edec08942f02f7851da1","5f2c359d691fb808de12f49d","6729dcac4125020011e0f99c","6729dcac4125020011e0f99d","6729dcac4125020011e0f99e"],"pdfStatus":"","project":"5ecd911e605d8a005f87ad63","releaseDate":"2020-05-26T21:58:54.164Z","createdAt":"2024-11-05T08:51:56.221Z","__v":1,"forked_from":"5ecd911e605d8a005f87ad69","updatedAt":"2024-11-05T08:52:15.492Z"},{"_id":"678f20d5e750410048a31473","version":"0.15","version_clean":"0.15.0","codename":"Illia","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":false,"categories":["5ecd911e605d8a005f87ad6b","678f20d5e750410048a313b8","678f20d5e750410048a313b9","5f29ed9e6bbb610144c7a102","5f29edec08942f02f7851da1","5f2c359d691fb808de12f49d","678f20d5e750410048a313ba","678f20d5e750410048a313bb","678f20d5e750410048a313bc"],"pdfStatus":"","project":"5ecd911e605d8a005f87ad63","releaseDate":"2020-05-26T21:58:54.164Z","createdAt":"2025-01-21T04:21:41.299Z","__v":0,"forked_from":"5ecd911e605d8a005f87ad69","updatedAt":"2025-01-21T04:21:41.299Z"},{"_id":"5ecd911e605d8a005f87ad69","version":"1.0","version_clean":"1.0.0","codename":"Gorgias","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5ecd911e605d8a005f87ad6b","5f29ed62afdb6902b28ece17","5f29ed6a99626a0025d8919b","5f29ed9e6bbb610144c7a102","5f29edec08942f02f7851da1","5f2c359d691fb808de12f49d","60b8f7a0c9b1e80079f6c135","6269c2f024af7a0170a822d4","6376b49e2ac94400030a7fd8"],"project":"5ecd911e605d8a005f87ad63","releaseDate":"2020-05-26T21:58:54.164Z","createdAt":"2020-05-26T21:58:54.164Z","__v":7},{"_id":"624287a469dbd3003ebc5563","version":"1.1","version_clean":"1.1.0","codename":"Lisa - Design updates","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5ecd911e605d8a005f87ad6b","624287a469dbd3003ebc54df","624287a469dbd3003ebc54e0","5f29ed9e6bbb610144c7a102","5f29edec08942f02f7851da1","5f2c359d691fb808de12f49d","624287a469dbd3003ebc54e1","624c9e2d2ed508002e768ab1","6376b49e2ac94400030a7fd7"],"project":"5ecd911e605d8a005f87ad63","releaseDate":"2020-05-26T21:58:54.164Z","createdAt":"2020-05-26T21:58:54.164Z","__v":2,"forked_from":"5ecd911e605d8a005f87ad69"}],"variableDefaults":[{"source":"","type":"","_id":"5ef3c9986e72a50012bcfe50","name":"domain","default":"my-domain"},null,{"source":"security","type":"http","_id":"67ab7bb4ff9e43002a85b664","name":"basicAuth","scheme":"basic","apiSetting":"6278eb1830673301a650d84c"}],"webhookEnabled":false,"isHubEditable":true},"projectStore":{"data":{"allow_crawlers":"disabled","canonical_url":null,"default_version":{"name":"1.0"},"description":"Gorgias Developer Portal. REST API reference and Guides.","glossary":[{"_id":"5eea87ff7726d50060bbe15f","term":"Ticket","definition":"A ticket is a conversation with a customer, on any channel. It can be on email, phone, chat, etc."}],"homepage_url":"https://www.gorgias.com","id":"5ecd911e605d8a005f87ad63","name":"gorgias-developers","parent":null,"redirects":[],"sitemap":"disabled","subdomain":"gorgias-developers","suggested_edits":"enabled","uri":"/projects/me","variable_defaults":[{"name":"domain","default":"my-domain","source":"","type":"","id":"5ef3c9986e72a50012bcfe50"},{"name":"basicAuth","scheme":"basic","source":"security","type":"http","id":"67ab7bb4ff9e43002a85b664"}],"webhooks":[],"api_designer":{"allow_editing":"enabled"},"custom_login":{"login_url":null,"logout_url":null},"features":{"mdx":"disabled"},"onboarding_completed":{"api":true,"appearance":true,"documentation":true,"domain":false,"jwt":true,"logs":true,"metricsSDK":false},"pages":{"not_found":null},"privacy":{"view":"public","password":null},"refactored":{"status":"disabled","migrated":"unknown"},"reference":{"api_sdk_snippets":"enabled","defaults":"always_use","json_editor":"disabled","oauth_flows":"disabled","request_history":"enabled","response_examples":"collapsed","response_schemas":"collapsed"},"seo":{"overwrite_title_tag":"disabled"},"plan":{"type":"business-annual-2024","grace_period":{"enabled":false,"end_date":null},"trial":{"expired":false,"end_date":"2020-06-17T21:58:54.100Z"}},"health_check":{"provider":"statuspage","settings":{"manual":{"status":"down","url":null},"statuspage":{"id":"2lqy3hys4460"}}},"integrations":{"aws":{"readme_webhook_login":{"region":null,"external_id":null,"role_arn":null,"usage_plan_id":null}},"bing":{"verify":null},"google":{"analytics":null,"site_verification":null},"heap":{"id":null},"koala":{"key":null},"localize":{"key":null},"recaptcha":{"site_key":"6Le3ebYpAAAAAI649QQc7uink1u90Th7j6HtZpCm","secret_key":null},"segment":{"key":null,"domain":null},"typekit":{"key":null},"zendesk":{"subdomain":null},"intercom":{"app_id":null,"secure_mode":{"key":null,"email_only":false}}},"permissions":{"appearance":{"private_label":"enabled","custom_code":{"css":"enabled","html":"enabled","js":"disabled"}}},"appearance":{"brand":{"primary_color":"#242F8C","link_color":"#0075FF","theme":"system"},"changelog":{"layout":"collapsed","show_author":true,"show_exact_date":false},"markdown":{"callouts":{"icon_font":"emojis"}},"table_of_contents":"enabled","whats_next_label":null,"footer":{"readme_logo":"show"},"logo":{"size":"default","dark_mode":{"uri":null,"url":"https://files.readme.io/d4ae1cd-gorgias_dark.svg","name":"gorgias dark.svg","width":251,"height":60,"color":"#fff9f4","links":{"original_url":null}},"main":{"uri":null,"url":"https://files.readme.io/e509c23-5e693ac1927efe8a51c9662b_logo-gorgias.svg","name":"5e693ac1927efe8a51c9662b_logo-gorgias.svg","width":175,"height":40,"color":"#161616","links":{"original_url":null}},"favicon":{"uri":null,"url":"https://files.readme.io/e0504de-small-blue_logo.png","name":"blue logo.png","width":32,"height":32,"color":"#2a8bff","links":{"original_url":"https://files.readme.io/076a823-blue_logo.png"}}},"custom_code":{"css":"/* hide responses definitions in the sidebar */\n.hub-reference-response-definitions {\n display: none !important;\n}\n\n.react-json-view {\n font-family: Monaco,lucida console,monospace !important;\n padding: 0 !important;\n letter-spacing: 0 !important;\n}\n\n.react-json-view .variable-row {\n padding-top: 0 !important;\n padding-bottom: 0 !important;\n}\n.react-json-view .object-key {\n color: #e8e8e8 !important;\n letter-spacing: inherit !important;\n}\n.react-json-view .variable-value > div {\n color: #dd925f !important;\n}\n.react-json-view .expanded-icon > svg,\n.react-json-view .collapsed-icon > svg {\n\tcolor: #6c8eef!important;\n}\n.react-json-view .array-key {\n color: #d7a3ff !important;\n}\n.react-json-view .string-value {\n color: #b5bc67 !important;\n}\n.react-json-view .node-ellipsis {\n\tfont-size: inherit !important;\n}","js":null,"html":{"header":null,"home_footer":null,"page_footer":"<script>\n window.setTimeout(() => {\n let typeFormScript = document.createElement('script');\n typeFormScript.setAttribute('src','//embed.typeform.com/next/embed.js');\n document.head.appendChild(typeFormScript);\n }, 2000);\n</script>\n\n<!--Gorgias Chat Widget Start-->\n<script id=\"gorgias-chat-widget-install-v2\" src=\"https://config.gorgias.chat/gorgias-chat-bundle-loader.js?applicationId=16724\"></script>\n<!--Gorgias Chat Widget End-->\n\n<div class=\"powr-popup\" id=\"d7e537b7_1655157718\"></div><script src=\"https://www.powr.io/powr.js?platform=shopify\"></script>"}},"header":{"type":"overlay","gradient_color":null,"overlay":{"fill":"cover","type":"custom","position":"top-center","image":{"uri":null,"url":"https://files.readme.io/14e37b9-hero.png","name":"14e37b9-hero.png","width":2880,"height":600,"color":"#000000","links":{"original_url":null}}}},"navigation":{"first_page":"landing_page","left":[],"logo_link":"landing_page","right":[],"sub_nav":[],"subheader_layout":"links","version":"disabled","links":{"home":{"label":"Home","visibility":"enabled"},"graphql":{"label":"GraphQL","visibility":"disabled"},"guides":{"label":"Guides","alias":"Quickstart","visibility":"enabled"},"reference":{"label":"API Reference","alias":null,"visibility":"enabled"},"recipes":{"label":"Recipes","alias":null,"visibility":"disabled"},"changelog":{"label":"Changelog","alias":null,"visibility":"enabled"},"discussions":{"label":"Discussions","alias":null,"visibility":"disabled"}}}},"git":{"connection":{"repository":{},"status":"inactive"}}}},"version":{"_id":"5ecd911e605d8a005f87ad69","version":"1.0","version_clean":"1.0.0","codename":"Gorgias","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5ecd911e605d8a005f87ad6b","5f29ed62afdb6902b28ece17","5f29ed6a99626a0025d8919b","5f29ed9e6bbb610144c7a102","5f29edec08942f02f7851da1","5f2c359d691fb808de12f49d","60b8f7a0c9b1e80079f6c135","6269c2f024af7a0170a822d4","6376b49e2ac94400030a7fd8"],"project":"5ecd911e605d8a005f87ad63","releaseDate":"2020-05-26T21:58:54.164Z","createdAt":"2020-05-26T21:58:54.164Z","__v":7}},"isDetachedProductionSite":false,"lang":"en","langFull":"Default","reqUrl":"/","version":{"_id":"5ecd911e605d8a005f87ad69","version":"1.0","version_clean":"1.0.0","codename":"Gorgias","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5ecd911e605d8a005f87ad6b","5f29ed62afdb6902b28ece17","5f29ed6a99626a0025d8919b","5f29ed9e6bbb610144c7a102","5f29edec08942f02f7851da1","5f2c359d691fb808de12f49d","60b8f7a0c9b1e80079f6c135","6269c2f024af7a0170a822d4","6376b49e2ac94400030a7fd8"],"project":"5ecd911e605d8a005f87ad63","releaseDate":"2020-05-26T21:58:54.164Z","createdAt":"2020-05-26T21:58:54.164Z","__v":7}}"></script></div><div id="hub-container"><div class="hub-container"><div state-container ng-attr-id="{{state.current().root !== 'docs' && 'react-app-content-container'}}"><div id="replace-view" ng-non-bindable></div></div></div></div><script>!function(){var analytics=window.analytics=window.analytics||[];if(!analytics.initialize)if(analytics.invoked)window.console&&console.error&&console.error("Segment snippet included twice.");else{analytics.invoked=!0;analytics.methods=["trackSubmit","trackClick","trackLink","trackForm","pageview","identify","group","track","ready","alias","page","once","off","on"];analytics.factory=function(t){return function(){var e=Array.prototype.slice.call(arguments);e.unshift(t);analytics.push(e);return analytics}};for(var t=0;t<analytics.methods.length;t++){var e=analytics.methods[t];analytics[e]=analytics.factory(e)}analytics.load=function(t){var e=document.createElement("script");e.type="text/javascript";e.async=!0;e.src=("https:"===document.location.protocol?"https://":"http://")+ "cdn.segment.com" +"/analytics.js/v1/"+t+"/analytics.min.js";var n=document.getElementsByTagName("script")[0];n.parentNode.insertBefore(e,n)};analytics.SNIPPET_VERSION="3.0.1"; analytics.load("VoXGHWrAPqGDDEKAbDxq4ILaKenSrfaZ"); }}(); </script><script>var is_hub = true; var is_hub2 = true; var is_hub_edit = true; </script><div id="ssr-end"><script id="__LOADABLE_REQUIRED_CHUNKS__" type="application/json">[6601,1126,6563,9772,4904,7449,7372,187,734,954,1167,2395,9321,3073,1008,7188,5753,2852,2249,3901,7783,1456,4935,4287,4201,1936,5798,3221,7327,7717,5359,5948,8230,3307,1343,6060,7356,1313,678,1666,3906,3787,1080,9852,8684,1202,9575,2144,9141,5408,2637,2402,3859,4467,1731,2447,8063,2578,2705,169,2548,2183,4778,6262,3626,3556,7779,4793,2616,3412,7031,8899]</script><script id="__LOADABLE_REQUIRED_CHUNKS___ext" type="application/json">{"namedChunks":["routes-SuperHub","Header","core-icons-chevron-up-down-svg","routes-Doc","Footer","core-icons-search-svg","core-icons-custom-pages-svg","routes-SuperHub-Routes","core-icons-more-vertical-svg","core-icons-lock-svg","RMDX","routes-Reference","core-icons-webhook-svg","routes-PageNotFound","routes-Landing","Editor","core-icons-x-circle-svg","core-icons-suggested-edits-svg","core-icons-alert-circle-svg","core-icons-arrow-right-svg","routes-Changelog","Post","routes-Discuss","Page","core-icons-chevron-down-svg","routes-Tutorials","List","CustomPage","routes-CustomPage","core-icons-arrow-up-right-svg","core-icons-eye-off-svg","core-icons-chevron-right-svg","core-icons-plus-svg","core-icons-folder-plus-svg","core-icons-file-svg","core-icons-eye-svg","SuperHub-CustomPage","core-icons-book-svg","core-icons-key-svg","core-icons-gauge-circle-svg","core-icons-star-svg","core-icons-trending-up-svg","core-icons-callout-info-svg","core-icons-message-circle-svg","New"]}</script> <script async data-chunk="main" src="https://cdn.readme.io/public/hub/web/main.871db54d053c293b178f.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6601.cef2fa12a9b5e2b9df03.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/1126.9d43ffa1039df16a8271.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6563.fbd3d15eee3b5e94f665.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/9772.89a3e895d3051e33cd73.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/4904.1067704c85da57778e22.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7449.dae0332305a8704415a6.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7372.fbd27ab77e6e47de9931.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/187.23cea47109f7f88417f6.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/734.2949e3d7010fa5c21ffd.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/954.53ce7f86793664155f78.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/1167.a6c63c62c8690225da20.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/2395.771431a607874f268eb2.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/9321.7bab74274e71e18bb347.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/3073.ef6aff2d0ae6023765f1.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/1008.c5d3d5f6718d217517a6.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7188.f444adf64944d115c52b.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/5753.72c5d7402efc1cfa5881.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/routes-SuperHub.3432b44653552d31effc.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/2249.08687f22f6d6de29577d.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/3901.9a23139e8c32bd6a1186.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/7783.54e7cbd61e710313e1e0.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/Header.415a3e3f42422a2546f5.js"></script> <script async data-chunk="core-icons-chevron-up-down-svg" src="https://cdn.readme.io/public/hub/web/core-icons-chevron-up-down-svg.6aae957df71e6f4c5e24.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/4287.916cdd386055d2c5d238.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/4201.9726bbf672400e046cc2.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/routes-Doc.ab23d1cf8ea817ed6084.js"></script> <script async data-chunk="Footer" src="https://cdn.readme.io/public/hub/web/Footer.732d39065ba473dca3be.js"></script> <script async data-chunk="core-icons-search-svg" src="https://cdn.readme.io/public/hub/web/core-icons-search-svg.ad9cac962958d30983a7.js"></script> <script async data-chunk="core-icons-custom-pages-svg" src="https://cdn.readme.io/public/hub/web/core-icons-custom-pages-svg.444e514638d9afbec182.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/7717.c3f46aef4dac129abcfb.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/5359.fb0c48929b1827a8a2b2.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/5948.a51402657e2eb40ab43b.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/8230.776279fe7bfd3c0ffd09.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.4630fef2d52dd3c2b8ff.js"></script> <script async data-chunk="core-icons-more-vertical-svg" src="https://cdn.readme.io/public/hub/web/core-icons-more-vertical-svg.4822b3f831e11095980d.js"></script> <script async data-chunk="core-icons-lock-svg" src="https://cdn.readme.io/public/hub/web/core-icons-lock-svg.70942d3ee6bad6267696.js"></script> <script async data-chunk="RMDX" src="https://cdn.readme.io/public/hub/web/RMDX.6966846032c03969e44f.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/routes-Reference.a6b1c6bee69d46fd161f.js"></script> <script async data-chunk="core-icons-webhook-svg" src="https://cdn.readme.io/public/hub/web/core-icons-webhook-svg.fe540ea1c09e1c0e0247.js"></script> <script async data-chunk="routes-PageNotFound" src="https://cdn.readme.io/public/hub/web/routes-PageNotFound.e4a4a4dbb41ce1f8c60f.js"></script> <script async data-chunk="routes-Landing" src="https://cdn.readme.io/public/hub/web/3906.b84848dda7e7f59abf47.js"></script> <script async data-chunk="routes-Landing" src="https://cdn.readme.io/public/hub/web/routes-Landing.43a15229736801911d5a.js"></script> <script async data-chunk="Editor" src="https://cdn.readme.io/public/hub/web/Editor.fcff689c44b953a512d6.js"></script> <script async data-chunk="core-icons-x-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-x-circle-svg.abc0e0ea5b7f9dff667c.js"></script> <script async data-chunk="core-icons-suggested-edits-svg" src="https://cdn.readme.io/public/hub/web/core-icons-suggested-edits-svg.8d2d8ac2fd22ded9238d.js"></script> <script async data-chunk="core-icons-alert-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-alert-circle-svg.4cee8264c97045599b56.js"></script> <script async data-chunk="core-icons-arrow-right-svg" src="https://cdn.readme.io/public/hub/web/core-icons-arrow-right-svg.eadb74658f93b4e7d75f.js"></script> <script async data-chunk="routes-Changelog" src="https://cdn.readme.io/public/hub/web/routes-Changelog.05be16260f5ffacc35a3.js"></script> <script async data-chunk="Post" src="https://cdn.readme.io/public/hub/web/Post.0ba0ba3778e78d8254e8.js"></script> <script async data-chunk="routes-Discuss" src="https://cdn.readme.io/public/hub/web/routes-Discuss.9a682a77c9083927aeaf.js"></script> <script async data-chunk="Page" src="https://cdn.readme.io/public/hub/web/2637.d47bf77a75f266a70e80.js"></script> <script async data-chunk="Page" src="https://cdn.readme.io/public/hub/web/Page.6d18db72aa3774dd903a.js"></script> <script async data-chunk="core-icons-chevron-down-svg" src="https://cdn.readme.io/public/hub/web/core-icons-chevron-down-svg.e20b84e9871bd73d1b8c.js"></script> <script async data-chunk="routes-Tutorials" src="https://cdn.readme.io/public/hub/web/routes-Tutorials.c83f9bb228d60f5f7f6b.js"></script> <script async data-chunk="List" src="https://cdn.readme.io/public/hub/web/List.b1dd4485529aa4a7aa11.js"></script> <script async data-chunk="CustomPage" src="https://cdn.readme.io/public/hub/web/CustomPage.29543915f3e70fa960d7.js"></script> <script async data-chunk="core-icons-arrow-up-right-svg" src="https://cdn.readme.io/public/hub/web/core-icons-arrow-up-right-svg.8ec73f7e322d79a2695b.js"></script> <script async data-chunk="core-icons-eye-off-svg" src="https://cdn.readme.io/public/hub/web/core-icons-eye-off-svg.b2b8b241b4b324dfd9c1.js"></script> <script async data-chunk="core-icons-chevron-right-svg" src="https://cdn.readme.io/public/hub/web/core-icons-chevron-right-svg.34d126524d8ea236d174.js"></script> <script async data-chunk="core-icons-plus-svg" src="https://cdn.readme.io/public/hub/web/core-icons-plus-svg.a49fb76ac2661b5e1c7e.js"></script> <script async data-chunk="core-icons-folder-plus-svg" src="https://cdn.readme.io/public/hub/web/core-icons-folder-plus-svg.2c200438e59611867262.js"></script> <script async data-chunk="core-icons-file-svg" src="https://cdn.readme.io/public/hub/web/core-icons-file-svg.24d3e20044ef331cf0d2.js"></script> <script async data-chunk="core-icons-eye-svg" src="https://cdn.readme.io/public/hub/web/core-icons-eye-svg.b2103692a3c209893efe.js"></script> <script async data-chunk="SuperHub-CustomPage" src="https://cdn.readme.io/public/hub/web/SuperHub-CustomPage.edef7b501475b233c5a2.js"></script> <script async data-chunk="core-icons-book-svg" src="https://cdn.readme.io/public/hub/web/core-icons-book-svg.556c5a2abddd44b2284c.js"></script> <script async data-chunk="core-icons-key-svg" src="https://cdn.readme.io/public/hub/web/core-icons-key-svg.71e09670b926900508b8.js"></script> <script async data-chunk="core-icons-gauge-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-gauge-circle-svg.fff25782546fef314a09.js"></script> <script async data-chunk="core-icons-star-svg" src="https://cdn.readme.io/public/hub/web/core-icons-star-svg.b834e1612cb2af1e174e.js"></script> <script async data-chunk="core-icons-trending-up-svg" src="https://cdn.readme.io/public/hub/web/core-icons-trending-up-svg.0dd920b0698e57f75afa.js"></script> <script async data-chunk="core-icons-callout-info-svg" src="https://cdn.readme.io/public/hub/web/core-icons-callout-info-svg.79b14e8568c9cecbc827.js"></script> <script async data-chunk="core-icons-message-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-message-circle-svg.1e24c2d2eb4f9a6ede5d.js"></script> <script async data-chunk="New" src="https://cdn.readme.io/public/hub/web/New.19db37c76f3b9d17353d.js"></script></div><script>(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); </script><script>ga('create', 'UA-57038199-12', 'auto', {'name': 'custom'}); $(window).on('pageLoad', function(e, state){ ga('custom.send', 'pageview', window.location.pathname); }); </script><script>$(window).on('pageLoad', function(e, state){ analytics.page(window.location.pathname, state.meta.title, { "context": { "plugin": { "name": "readme_io", "version": "1.0.0" } } }) }); </script><script> window.setTimeout(() => { let typeFormScript = document.createElement('script'); typeFormScript.setAttribute('src','//embed.typeform.com/next/embed.js'); document.head.appendChild(typeFormScript); }, 2000); </script> <!--Gorgias Chat Widget Start--> <script id="gorgias-chat-widget-install-v2" src="https://config.gorgias.chat/gorgias-chat-bundle-loader.js?applicationId=16724"></script> <!--Gorgias Chat Widget End--> <div class="powr-popup" id="d7e537b7_1655157718"></div><script src="https://www.powr.io/powr.js?platform=shopify"></script><script id="hub-me" type="application/json" data-json="{"loggedIn":false,"search":{"app":"T28YKFATPY","token":"NjE3NWQxODNjOGZlZDcwNGVmYWFmYTYwYzdjMGIxYmU4NjJjZWUyNGE2NzI1ZDM0OTgzNzVkMWYwZmNhZTU0Y3RhZ0ZpbHRlcnM9KHByb2plY3Q6NWVjZDkxMWU2MDVkOGEwMDVmODdhZDYzKSwodmVyc2lvbjpub25lLHZlcnNpb246NWVjZDkxMWU2MDVkOGEwMDVmODdhZDY5KSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlLGluZGV4OkJsb2cp","filters":"tagFilters=(project:5ecd911e605d8a005f87ad63),(version:none,version:5ecd911e605d8a005f87ad69),(hidden:none,hidden:false),(index:CustomPage,index:Page,index:Blog)","metaData":[{"modules":{"landing":true,"docs":true,"examples":true,"reference":true,"changelog":true,"discuss":false,"suggested_edits":true,"logs":false,"custompages":true,"tutorials":false,"graphql":false},"id":"5ecd911e605d8a005f87ad63","name":"gorgias-developers","subdomain":"gorgias-developers","subpath":"","nav_names":{"docs":"Quickstart","reference":"","changelog":"","discuss":"","tutorials":"","recipes":""}}]}}"></script><script id="readme-data-baseUrl" type="application/json" data-json=""/""></script></body></html>