<!DOCTYPE html><html lang="en" xmlns="http://www.w3.org/1999/xhtml" xmlns:fb="https://www.facebook.com/2008/fbml" itemscope="itemscope" itemtype="http://schema.org/Product"><head><meta charset="utf-8"><meta name="readme-deploy" content="5.316.0"><script src="https://browser.sentry-cdn.com/6.19.7/bundle.tracing.min.js" integrity="sha384-lEBvyPG01tsv1WahtwAQevkCCh3NjqUNlz93IATGFmFuVbVyx6dReoQ035OOjNsM" crossorigin="anonymous"></script><script>Sentry.init({ dsn: "https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166", environment: "production", release: "5.316.0", tracesSampleRate: 0, initialScope: { tags: { 'readme-component': 'dash' } } }); </script><title ng-bind="Title.get()">ReadMe</title><meta http-equiv="Content-type" content="text/html;charset=UTF-8"><meta name="keywords" content="readme,developer hub,documentation"><meta name="description" content="Create beautiful product and API documentation with our developer friendly platform."><link rel="stylesheet" href="https://use.typekit.net/xxi6uhs.css"><link rel="shortcut icon" href="https://cdn.readme.io/public/img/favicon.ico?1743445836763" type="image/x-icon"><meta property="fb:app_id" content="293989217296609"><meta property="og:title" content="ReadMe"><meta property="og:description" content="Create beautiful product and API documentation with our developer friendly platform."><meta property="og:url" content="http://readme.io"><meta property="og:image" content="http://readme.io/img/image.png"><meta property="og:site_name" content="ReadMe"><meta property="fb:admins" content="1037213945"><meta name="slack-app-id" content="AQBR3NZUY"><meta name="csrf-token" content="undefined"><meta id="domain" content="readme.io"><link rel="stylesheet" href="https://cdn.readme.io/public/css/bundle-dash.css?1743445836763"><link data-chunk="routes-Dash-Onboarding" rel="preload" as="style" href="/public/dash/web/routes-Dash-Onboarding.3e272eec30acf6c51957.css"> <link data-chunk="main" rel="preload" as="style" href="/public/dash/web/main.f102426426c51e0cffc9.css"> <link data-chunk="main" rel="preload" as="style" href="/public/dash/web/ui-styles.84862794aed93a5ff856.css"> <link data-chunk="main" rel="preload" as="script" href="/public/dash/web/main.b905300bfbf6f3a0513f.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/13766.65998331e4227b21d55d.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/74575.d21397d3ee4e71eda844.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/64241.99b9d25e617885fc8b8f.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/27672.315f176251fbde4ea3f6.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/64772.159293a281af969fe540.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/86651.58d84a1d02557d1e8c74.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/6146.f99bcbc8d654cc36d7c8.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/40725.0d1fdab13c142514db60.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/7799.7c2d9f175044b84a87ef.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/59503.7e89c71e5a08fe372234.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/12055.089c555faabf50bc2c2f.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/66038.0a912bff7a21e6046567.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/43460.9eab9c137f8c08cec6ad.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/84930.54ac01fef05535e5e42f.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/routes-Dash-Onboarding.b967e85fb9825f2319d5.js"> <link data-chunk="core-icons-arrow-right-svg" rel="preload" as="script" href="/public/dash/web/core-icons-arrow-right-svg.42dbfc2065f8c00c6e4d.js"> <link data-chunk="main" rel="stylesheet" href="/public/dash/web/ui-styles.84862794aed93a5ff856.css"> <link data-chunk="main" rel="stylesheet" href="/public/dash/web/main.f102426426c51e0cffc9.css"> <link data-chunk="routes-Dash-Onboarding" rel="stylesheet" href="/public/dash/web/routes-Dash-Onboarding.3e272eec30acf6c51957.css"><script type="text/javascript">window.FS = { identify: () => {} }; </script><script>(function(){var w=window;var ic=w.Intercom;if(typeof ic==="function"){ic('reattach_activator');ic('update',intercomSettings);}else{var d=document;var i=function(){i.c(arguments)};i.q=[];i.c=function(args){i.q.push(args)};w.Intercom=i;function l(){var s=d.createElement('script');s.type='text/javascript';s.async=true;s.src='https://widget.intercom.io/widget/m6855w1q';var x=d.getElementsByTagName('script')[0];x.parentNode.insertBefore(s,x);}if(w.attachEvent){w.attachEvent('onload',l);}else{w.addEventListener('load',l,false);}}})() </script></head><body><div class="ng-non-bindable"><script id="dashReact-props" data-initial-props="{"baseUrl":"/to/universe/?redirect=%2F","context":{"labs":{},"user":{},"terms":[],"variables":{"user":{},"defaults":[]},"project":{"_id":"586bd961c3ba161b00bee1f1","appearance":{"changelog":{"layoutExpanded":false,"showAuthor":true,"showExactDate":false},"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":"#4E78F1","main_alt":"#3CC6F2","header_text":"","body_highlight":"#3A66E5","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":"solid","img":[],"img_size":"auto","img_pos":"tl"},"body":{"style":"none"},"global_landing_page":{"html":"","redirect":""},"allowApiExplorerJsonEditor":false,"referenceSimpleMode":true,"referenceLayout":"row","link_logo_to_url":false,"theme":"solid","colorScheme":"light","overlay":"blueprint","landing":true,"sticky":false,"hide_logo":true,"childrenAsPills":false,"subheaderStyle":"dropdown","splitReferenceDocs":false,"showMetricsInReference":true,"logo":["https://files.readme.io/f9d220d-small-grey-color-small.png","grey-color-small.png",164,30,"#000000","https://files.readme.io/33caf50-grey-color-small.png"],"loginLogo":[],"logo_white":["https://files.readme.io/55d0959-small-logo.png","logo.png",323,80,"#f4f4f4","https://files.readme.io/558e02f-logo.png"],"logo_white_use":true,"logo_large":false,"favicon":[],"stylesheet":"","stylesheet_hub2":".content-body .magic-block-callout.type-info {\n border-color: #E2E5E7;\n background-color: #F5F5F5;\n}\n.content-body .magic-block-callout.type-info h3 {\n color: #4E78F1;\n}\n.content-body .magic-block-callout .fa.fa-info-circle {\n color: #4E78F1;\n}\n\n.content-body h2 {\n color: #FFF; \n}\n\np {\n line-height: 18px; \n margin-bottom: 20px;\n font-size:16px;\n}","stylesheet_hub3":"","javascript":"","javascript_hub2":"","html_promo":"","html_body":"","html_footer":"","html_head":"","html_footer_meta":"","html_hidelinks":false,"showVersion":false,"hideTableOfContents":false,"nextStepsLabel":"","promos":[{"extras":{"type":"buttons","buttonPrimary":"docs","buttonSecondary":""},"title":"Universe Developer Portal","text":"Welcome to the Universe Developer Portal. You'll find comprehensive guides and documentation to help you start working with Universe as quickly as possible, as well as support if you get stuck. Let's jump right in!","_id":"586bd961c3ba161b00bee1f2"}]},"currentOnboardingStep":4,"custom_domain":"developers.universe.com","childrenProjects":[],"derivedPlan":"startup","description":"The API for ticketing.","error404":"","experiments":[],"first_page":"landing","flags":{"allowReusableOTPs":false,"alwaysShowDocPublishStatus":false,"allowUnsafeCustomHtmlSuggestionsFromNonAdmins":false,"allowXFrame":false,"apiAccessRevoked":false,"bidiSync":false,"changelogRssAlwaysPublic":false,"childManagedBidi":false,"correctnewlines":false,"customComponents":false,"dashReact":false,"disablePasswordlessLogin":false,"directGoogleToStableVersion":false,"disableAnonForum":false,"disableAutoTranslate":false,"disableSignups":false,"enableOidc":false,"enterprise":false,"graphql":false,"hideEnforceSSO":false,"localLLM":false,"mdx":false,"newEditorDash":true,"oauth":false,"passwordlessLogin":"default","owlbotAi":false,"rdmdCompatibilityMode":false,"reviewWorkflow":true,"singleProjectEnterprise":false,"star":false,"staging":false,"superHub":false,"superHubGlobalCustomBlocks":false,"superHubMigrationSelfServeFlow":true,"gitSidebar":false,"translation":false,"disableDiscussionSpamRecaptchaBypass":false},"fullBaseUrl":"https://developers.universe.com/","git":{"sync":{"linked_repository":{},"connections":[]}},"glossaryTerms":[],"graphqlSchema":"","gracePeriod":{"enabled":false,"endsAt":null},"shouldGateDash":false,"healthCheck":{"provider":""},"intercom_secure_emailonly":false,"intercom":"","is_active":true,"internal":"","jwtExpirationTime":0,"landing_bottom":[{"type":"three","alignment":"left","group0":{"title":"OAuth","text":"[Auth Code Grant Flow](https://developers.universe.com/v3/docs/authorizing-with-oauth)\n[Client Credentials Flow](https://developers.universe.com/docs/client-credentials-flow)\n[read more...](https://developers.universe.com/docs/authorizing-with-oauth)"},"group1":{"title":"Guides","text":"[GraphQL Overview](https://developers.universe.com/docs/graphql)\n[GraphQL Basic Usage](https://developers.universe.com/docs/basic-usage-1)\n[read more...](https://developers.universe.com/docs)"},"group2":{"title":"API","text":"[GraphQL Explorer](https://www.universe.com/graphiql)\n[RESTful API](https://developers.universe.com/v3/reference#guestlists)\n[read more...](https://developers.universe.com/reference)"}}],"mdxMigrationStatus":"rdmd","metrics":{"monthlyLimit":0,"monthlyPurchaseLimit":0,"thumbsEnabled":false},"modules":{"landing":true,"docs":true,"examples":true,"reference":true,"graphql":false,"changelog":true,"discuss":false,"suggested_edits":true,"custompages":true,"tutorials":false},"name":"Universe Public API","nav_names":{"docs":"Guides","reference":"API","changelog":"Changelog","discuss":"","recipes":"","tutorials":""},"oauth_url":"","onboardingCompleted":{"api":true,"appearance":true,"documentation":true,"domain":true,"jwt":true,"logs":false,"metricsSDK":false},"owlbot":{"copilot":{"enabled":false,"hasBeenUsed":false,"installedCustomPage":""},"customization":{"tone":"neutral","customTone":"","answerLength":"long","forbiddenWords":"","defaultAnswer":""},"enabled":false,"isPaying":false},"owner":{"id":"586bd95728ef3c39009b0444","email":"conner.fritz@universe.com","name":"Conner Fritz"},"plan":"startup","planOverride":"","planSchedule":{"stripeScheduleId":null,"changeDate":null,"nextPlan":null},"planStatus":"active","planTrial":"startup","readmeScore":{"components":{"newDesign":{"enabled":true,"points":25},"reference":{"enabled":true,"points":50},"tryItNow":{"enabled":true,"points":35},"syncingOAS":{"enabled":false,"points":10},"customLogin":{"enabled":true,"points":25},"metrics":{"enabled":false,"points":40},"recipes":{"enabled":false,"points":15},"pageVoting":{"enabled":false,"points":1},"suggestedEdits":{"enabled":true,"points":10},"support":{"enabled":false,"points":5},"htmlLanding":{"enabled":false,"points":5},"guides":{"enabled":true,"points":10},"changelog":{"enabled":true,"points":5},"glossary":{"enabled":false,"points":1},"variables":{"enabled":false,"points":1},"integrations":{"enabled":false,"points":2}},"totalScore":160},"reCaptchaSiteKey":"","reference":{"alwaysUseDefaults":true,"defaultExpandResponseExample":false,"defaultExpandResponseSchema":false,"enableOAuthFlows":false},"seo":{"overwrite_title_tag":false},"stable":{"version":"3","version_clean":"3.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5b4cc75f666e630003bc9106","5879a0642e05e71900617fc1","5879a5882e05e71900617fc5","5879aad62e05e71900617fc8","5879acf21fe2370f001d07c1","5879acff1fe2370f001d07c2","5879ad031fe2370f001d07c3","5879ad057a58130f00303d72","587d26eb73e9731b008892b0","591b62418f2e010f00d382cd","5b4cc75f666e630003bc9107","5921fd03aca6050f005b1cea","5b4cc75f666e630003bc9108","5b4cc75f666e630003bc9109","593b0a239c56ba000f30233c","5953eff2c356e9001b125124","5b4cc75f666e630003bc910a","5b4cc75f666e630003bc910b","5b4cc75f666e630003bc910c","5b4cc75f666e630003bc910d","5b4cc75f666e630003bc910e","59a59ab34125d10031dbee45","5b4cd2fd9275b5000331e785","5b562065ddebdc0003ac54a7","5b895ed47d6ac70003cd5737","5b89783ef73f990003d535ea","6376bee0127d99000316938c"],"pdfStatus":"","source":"readme","_id":"5b4cc75f666e630003bc912a","__v":4,"project":"586bd961c3ba161b00bee1f1","forked_from":"586bd961c3ba161b00bee1f4","createdAt":"2017-01-03T17:03:29.977Z","releaseDate":"2017-01-03T17:03:29.977Z","apiRegistries":[]},"subdomain":"universe","subpath":"","superHubWaitlist":false,"topnav":{"left":[{"type":"docs"},{"type":"reference"},{"url":"https://careers.universe.com/","text":"Careers","type":"url"},{"type":"url","url":"https://engineering.universe.com/","text":"Blog"},{"type":"custompage","page":"open-source","text":"Open Source"}],"right":[{"type":"user"}],"bottom":[],"edited":true},"trial":{"trialDeadlineEnabled":true,"trialEndsAt":"2017-02-17T17:03:29.950Z"},"translate":{"provider":"transifex","show_widget":false,"key_public":"","org_name":"","project_name":"","languages":[]},"url":"https://www.universe.com/","versions":[{"version":"2","version_clean":"2.0.0","codename":"","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"pdfStatus":"","_id":"586bd961c3ba161b00bee1f4","releaseDate":"2017-01-03T17:03:29.977Z"},{"version":"3","version_clean":"3.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"pdfStatus":"","_id":"5b4cc75f666e630003bc912a","releaseDate":"2017-01-03T17:03:29.977Z"},{"version":"4","version_clean":"4.0.0","codename":"","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"pdfStatus":"","_id":"5cc9e3c1340d190045e5833f","releaseDate":"2017-01-03T17:03:29.977Z"}],"variableDefaults":[],"webhookEnabled":false},"version":{"version":"3","version_clean":"3.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5b4cc75f666e630003bc9106","5879a0642e05e71900617fc1","5879a5882e05e71900617fc5","5879aad62e05e71900617fc8","5879acf21fe2370f001d07c1","5879acff1fe2370f001d07c2","5879ad031fe2370f001d07c3","5879ad057a58130f00303d72","587d26eb73e9731b008892b0","591b62418f2e010f00d382cd","5b4cc75f666e630003bc9107","5921fd03aca6050f005b1cea","5b4cc75f666e630003bc9108","5b4cc75f666e630003bc9109","593b0a239c56ba000f30233c","5953eff2c356e9001b125124","5b4cc75f666e630003bc910a","5b4cc75f666e630003bc910b","5b4cc75f666e630003bc910c","5b4cc75f666e630003bc910d","5b4cc75f666e630003bc910e","59a59ab34125d10031dbee45","5b4cd2fd9275b5000331e785","5b562065ddebdc0003ac54a7","5b895ed47d6ac70003cd5737","5b89783ef73f990003d535ea","6376bee0127d99000316938c"],"pdfStatus":"","source":"readme","_id":"5b4cc75f666e630003bc912a","__v":4,"project":"586bd961c3ba161b00bee1f1","forked_from":"586bd961c3ba161b00bee1f4","createdAt":"2017-01-03T17:03:29.977Z","releaseDate":"2017-01-03T17:03:29.977Z","apiRegistries":[]}},"apiBaseUrl":"/","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.316.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true,"tracesSampleRate":0},"shMigration":{"promoVideo":"https://www.youtube.com/embed/CIhJ1uWyLhk?si=qEeH4oqdT_ncz10p&start=300","forceWaitlist":true},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}},"location":"/to/universe?redirect=%2F","isOnboardingRoute":false,"shMigrationLock":false}"></script></div><div id="dashReact"><div class="App ThemeContext ThemeContext_dark " style="--color-primary:#333388;--color-primary-inverse:#fff;--color-primary-alt:#161659;--color-primary-darken-10:#252563;--color-primary-darken-20:#17173e;--color-primary-alpha-25:rgba(51, 51, 136, 0.25);--color-link-primary:#333388;--color-link-primary-darken-5:#2c2c75;--color-link-primary-darken-10:#252563;--color-link-primary-darken-20:#17173e;--color-link-primary-alpha-50:rgba(51, 51, 136, 0.5);--color-link-primary-alpha-25:rgba(51, 51, 136, 0.25);--color-link-background:rgba(51, 51, 136, 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)"></div><div class="ModalWrapper" id="modal-target"></div></div><div id="dashReact-end"><script id="__LOADABLE_REQUIRED_CHUNKS__" type="application/json">[13766,74575,64241,27672,64772,86651,6146,40725,7799,59503,12055,66038,43460,84930,7196,19575]</script><script id="__LOADABLE_REQUIRED_CHUNKS___ext" type="application/json">{"namedChunks":["routes-Dash-Onboarding","core-icons-arrow-right-svg"]}</script> <script async data-chunk="main" src="/public/dash/web/main.b905300bfbf6f3a0513f.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/13766.65998331e4227b21d55d.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/74575.d21397d3ee4e71eda844.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/64241.99b9d25e617885fc8b8f.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/27672.315f176251fbde4ea3f6.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/64772.159293a281af969fe540.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/86651.58d84a1d02557d1e8c74.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/6146.f99bcbc8d654cc36d7c8.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/40725.0d1fdab13c142514db60.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/7799.7c2d9f175044b84a87ef.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/59503.7e89c71e5a08fe372234.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/12055.089c555faabf50bc2c2f.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/66038.0a912bff7a21e6046567.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/43460.9eab9c137f8c08cec6ad.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/84930.54ac01fef05535e5e42f.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/routes-Dash-Onboarding.b967e85fb9825f2319d5.js"></script> <script async data-chunk="core-icons-arrow-right-svg" src="/public/dash/web/core-icons-arrow-right-svg.42dbfc2065f8c00c6e4d.js"></script></div></body><script>var is_hub = false; var is_hub_edit = false; var is_hub2 = false; </script><script src="https://cdn.readme.io/public/js/bundle-dash.js?1743445836763"></script></html>

CINXE.COM