Understanding the basics of Series’ Public API and how to get started
Welcome
Welcome to Series’ Public REST API documentation. In this article, you’ll learn how to make use of our public API endpoints to help you integrate them into your own applications, bots, games, and more.
Base API endpoint
Current base API endpoint: api.series.hrYou can call the base endpoint to check if the API system is online and working.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Series Documentation","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/sbg/D3AvpQPHOBPXGsor/logo/light.png?fit=max\u0026auto=format\u0026n=D3AvpQPHOBPXGsor\u0026q=85\u0026s=58002aaf01d4b56f70e6fce338fcb7fb","dark":"https://mintcdn.com/sbg/D3AvpQPHOBPXGsor/logo/dark.png?fit=max\u0026auto=format\u0026n=D3AvpQPHOBPXGsor\u0026q=85\u0026s=2fc41c7b6bfd0519db863deba5d2a6a4"},"favicon":"https://mintcdn.com/sbg/D3AvpQPHOBPXGsor/favicon.ico?fit=max\u0026auto=format\u0026n=D3AvpQPHOBPXGsor\u0026q=85\u0026s=c22c8eda929a2e166d9c478deae34682","api":{"playground":{}},"navbar":{"links":[{"href":"mailto:help@series.hr","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.series.hr"}},"footer":{"socials":{"discord":"https://discord.gg/series","github":"https://github.com/seriesremote","linkedin":"https://linkedin.com/company/seriesremote"}},"contextual":{"options":["copy","view"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Help Center","icon":"book-open-cover","href":"https://help.series.hr"},{"anchor":"Service Status","icon":"server","href":"https://status.series.hr"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"sbg","hasAudioNarration":false,"actualSubdomain":"sbg","customDomains":["docs.series.hr"],"gitSource":{"type":"github","owner":"serieshr","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6aa6c7928a94481b048b6168","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Flights","count":17},{"language":"default","tag":"Tickets","count":12},{"language":"default","tag":"Food \u0026 Beverage","count":11},{"language":"default","tag":"Sessions","count":8},{"language":"default","tag":"Attendance","count":7},{"language":"default","tag":"Hotel","count":6},{"language":"default","tag":"Applications","count":5},{"language":"default","tag":"Members","count":5},{"language":"default","tag":"Time-Off","count":5},{"language":"default","tag":"Activity Credits","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api/introduction","slug":"/api/introduction","pageMetadata":{"title":"Introduction","description":"Understanding the basics of Series' Public API and how to get started","href":"/api/introduction"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Understanding the basics of Series’ Public API and how to get started\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components},{Heading,ResponseField}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`welcome`,children:`Welcome`}),`\n`,_jsx(_components.p,{children:`Welcome to Series’ Public REST API documentation. In this article, you’ll learn how to make use of our public API endpoints to help you integrate them into your own applications, bots, games, and more.`}),`\n`,_jsx(Heading,{level:`2`,id:`base-api-endpoint`,children:`Base API endpoint`}),`\n`,_jsx(_components.p,{children:`Current base API endpoint: api.series.hr`}),`\n`,_jsx(_components.p,{children:`You can call the base endpoint to check if the API system is online and working.`}),`\n`,_jsx(ResponseField,{status:200})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Introduction","description":"Understanding the basics of Series' Public API and how to get started","href":"/api/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Welcome","slug":"welcome","depth":2,"children":[]},{"title":"Base API endpoint","slug":"base-api-endpoint","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"sbg","siteName":"Series Documentation","title":"Introduction - Series Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-24T18:16:05.574Z","originalFileLocation":"api/introduction.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Understanding the basics of Series\u0026#x27; Public API and how to get started\">\u003cmeta data-mint-head name=\"application-name\" content=\"Series Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sbg/DEc3fWrz13-ydN7E/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/sbg/DEc3fWrz13-ydN7E/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sbg/DEc3fWrz13-ydN7E/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/sbg/DEc3fWrz13-ydN7E/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/sbg/DEc3fWrz13-ydN7E/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sbg/DEc3fWrz13-ydN7E/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sbg/DEc3fWrz13-ydN7E/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/sbg/DEc3fWrz13-ydN7E/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/sbg/DEc3fWrz13-ydN7E/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introduction - Series Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Understanding the basics of Series\u0026#x27; Public API and how to get started\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Series Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.series.hr/api/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://sbg.mintlify.site/_mintlify/api/og/v2?division=Introduction+%26+basics\u0026amp;title=Introduction\u0026amp;description=Understanding+the+basics+of+Series%27+Public+API+and+how+to+get+started\u0026amp;theme=58ac37b299babb0a07d37cf5\u0026amp;signature=cb71c401ea66fafe2b85a2f2b2578a173c8c8a34d1a9d9c9d9cc6a3c1b29e30c\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Introduction - Series Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Understanding the basics of Series\u0026#x27; Public API and how to get started\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://sbg.mintlify.site/_mintlify/api/og/v2?division=Introduction+%26+basics\u0026amp;title=Introduction\u0026amp;description=Understanding+the+basics+of+Series%27+Public+API+and+how+to+get+started\u0026amp;theme=58ac37b299babb0a07d37cf5\u0026amp;signature=cb71c401ea66fafe2b85a2f2b2578a173c8c8a34d1a9d9c9d9cc6a3c1b29e30c\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/sbg/DEc3fWrz13-ydN7E/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Series Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.series.hr/api/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.series.hr/#organization\",\"name\":\"Series Documentation\",\"url\":\"https://docs.series.hr\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/sbg/D3AvpQPHOBPXGsor/logo/light.png?fit=max\u0026auto=format\u0026n=D3AvpQPHOBPXGsor\u0026q=85\u0026s=58002aaf01d4b56f70e6fce338fcb7fb\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.series.hr#website\",\"name\":\"Series Documentation\",\"url\":\"https://docs.series.hr\",\"publisher\":{\"@id\":\"https://docs.series.hr/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.series.hr/api/introduction#webpage\",\"url\":\"https://docs.series.hr/api/introduction\",\"name\":\"Introduction\",\"description\":\"Understanding the basics of Series' Public API and how to get started\",\"dateModified\":\"2026-01-24T18:16:05.574Z\",\"isPartOf\":{\"@id\":\"https://docs.series.hr#website\"},\"breadcrumb\":{\"@id\":\"https://docs.series.hr/api/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.series.hr/api/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Series Documentation\",\"item\":\"https://docs.series.hr\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introduction\",\"item\":\"https://docs.series.hr/api/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.series.hr/api/introduction#article\",\"headline\":\"Introduction\",\"name\":\"Introduction\",\"description\":\"Understanding the basics of Series' Public API and how to get started\",\"url\":\"https://docs.series.hr/api/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.series.hr/api/introduction#webpage\"},\"dateModified\":\"2026-01-24T18:16:05.574Z\",\"publisher\":{\"@id\":\"https://docs.series.hr/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.series.hr#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Series Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Series Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api/introduction.md","siteName":"Series Documentation","nav":{"global":{"anchors":[{"anchor":"Help Center","icon":"book-open-cover","href":"https://help.series.hr"},{"anchor":"Service Status","icon":"server","href":"https://status.series.hr"}]},"groups":[{"group":"Introduction \u0026 basics","pages":[{"title":"Introduction","href":"/api/introduction"}]},{"group":"Basic","pages":[{"title":"Health Check","description":"Check if the API is online and healthy","openapi":"GET /basic/health","href":"/api/endpoint/basic/health-check"},{"title":"Get API Info","openapi":"GET /basic/info","href":"/api/endpoint/basic/api-info"},{"title":"Check API Key","openapi":"GET /basic/check-key/{apiKey}","href":"/api/endpoint/basic/check-api-key"}]},{"group":"Activity","pages":[{"title":"Get Time Played","openapi":"GET /activity/time-played/{userId}","href":"/api/endpoint/activity/get-time-played"},{"title":"Get Messages Sent","openapi":"GET /activity/messages-sent/{userId}","href":"/api/endpoint/activity/get-messages-sent"},{"title":"Get User Sessions","openapi":"GET /activity/sessions/{userId}","href":"/api/endpoint/activity/get-user-sessions"}]},{"group":"Activity Credits","pages":[{"title":"Get Credit Status","openapi":"GET /activity-credits/status/{workspaceId}","href":"/api/endpoint/activity-credits/get-status"},{"title":"Get Credit History","openapi":"GET /activity-credits/history/{workspaceId}","href":"/api/endpoint/activity-credits/get-history"},{"title":"Get Credit Details","openapi":"GET /activity-credits/details/{workspaceId}","href":"/api/endpoint/activity-credits/get-details"}]},{"group":"Sessions","pages":[{"title":"Create Session","openapi":"POST /sessions/create","href":"/api/endpoint/sessions/create-session"},{"title":"Update Session","openapi":"PATCH /sessions/update/{sessionId}","href":"/api/endpoint/sessions/update-session"},{"title":"Get Session","openapi":"GET /sessions/get/{sessionId}","href":"/api/endpoint/sessions/get-session"},{"title":"List Sessions","openapi":"GET /sessions/list","href":"/api/endpoint/sessions/list-sessions"},{"title":"Delete Session","openapi":"DELETE /sessions/delete/{sessionId}","href":"/api/endpoint/sessions/delete-session"},{"title":"Claim Custom Role","openapi":"PATCH /sessions/{sessionId}/custom-roles/claim","href":"/api/endpoint/sessions/claim-custom-role"},{"title":"Quit Custom Role","openapi":"PATCH /sessions/{sessionId}/custom-roles/quit","href":"/api/endpoint/sessions/quit-custom-role"},{"title":"Remove From Custom Role","openapi":"PATCH /sessions/{sessionId}/custom-roles/remove","href":"/api/endpoint/sessions/remove-custom-role"}]},{"group":"Attendance","pages":[{"title":"Get Sessions","openapi":"GET /attendance/get-sessions","href":"/api/endpoint/attendance/get-sessions"},{"title":"Connect Server","openapi":"POST /attendance/connect-server/{sessionId}","href":"/api/endpoint/attendance/connect-server"},{"title":"Trigger Connect","openapi":"POST /attendance/trigger-connect/{sessionId}","href":"/api/endpoint/attendance/trigger-connect"},{"title":"Disconnect Server","openapi":"POST /attendance/disconnect-server/{sessionId}","href":"/api/endpoint/attendance/disconnect-server"},{"title":"Add Attendee","openapi":"POST /attendance/add-attendee/{sessionId}","href":"/api/endpoint/attendance/add-attendee"},{"title":"Update Attendee","openapi":"POST /attendance/update-attendee/{sessionId}","href":"/api/endpoint/attendance/update-attendee"},{"title":"Server Status","openapi":"GET /attendance/server-status/{sessionId}","href":"/api/endpoint/attendance/server-status"}]},{"group":"Game Moderation","pages":[{"title":"Check Player","openapi":"GET /game-moderation/check-player","href":"/api/endpoint/game-moderation/check-player"}]},{"group":"Applications","pages":[{"title":"List Application Centres","openapi":"GET /applications/list","href":"/api/endpoint/applications/list-centres"},{"title":"Get Application Centre","openapi":"GET /applications/centre/{centreId}","href":"/api/endpoint/applications/get-centre"},{"title":"Check Eligibility","openapi":"POST /applications/check-eligibility","href":"/api/endpoint/applications/check-eligibility"},{"title":"Submit Application","openapi":"POST /applications/submit","href":"/api/endpoint/applications/submit-application"},{"title":"Get Submission Status","openapi":"GET /applications/submission/{userId}/{centreId}","href":"/api/endpoint/applications/get-submission-status"}]},{"group":"Members","pages":[{"title":"Check Membership","openapi":"GET /members/check-membership/{userId}","href":"/api/endpoint/members/check-membership"},{"title":"List Members","openapi":"GET /members/list","href":"/api/endpoint/members/list-members"},{"title":"Get Member","openapi":"GET /members/get-member/{userId}","href":"/api/endpoint/members/get-member"},{"title":"Get Member Permissions","openapi":"GET /members/get-permissions/{userId}","href":"/api/endpoint/members/get-permissions"},{"title":"Get Member Info","openapi":"GET /members/info/{userId}","href":"/api/endpoint/members/get-member-info"}]},{"group":"Time-Off","pages":[{"title":"List Requests","openapi":"GET /time-off/list","href":"/api/endpoint/time-off/list-requests"},{"title":"Get Request","openapi":"GET /time-off/get/{requestId}","href":"/api/endpoint/time-off/get-request"},{"title":"Create Request","openapi":"POST /time-off/create","href":"/api/endpoint/time-off/create-request"},{"title":"Update Request","openapi":"PATCH /time-off/update/{requestId}","href":"/api/endpoint/time-off/update-request"},{"title":"Delete Request","openapi":"DELETE /time-off/delete/{requestId}","href":"/api/endpoint/time-off/delete-request"}]},{"group":"Hotel","pages":[{"title":"List Rooms","openapi":"GET /hotel/list","href":"/api/endpoint/hotel/list-rooms"},{"title":"Room Types","openapi":"GET /hotel/room-types","href":"/api/endpoint/hotel/room-types"},{"title":"Assign Room","openapi":"POST /hotel/assign-room","href":"/api/endpoint/hotel/assign-room"},{"title":"Reserve Room","openapi":"POST /hotel/reserve-room","href":"/api/endpoint/hotel/reserve-room"},{"title":"Set Maintenance","openapi":"POST /hotel/set-maintenance/{roomNumber}","href":"/api/endpoint/hotel/set-maintenance"},{"title":"Set Free","openapi":"POST /hotel/set-free/{roomNumber}","href":"/api/endpoint/hotel/set-free"}]},{"group":"Food \u0026 Beverage","pages":[{"title":"Menu Categories","openapi":"GET /fnb/menu-categories","href":"/api/endpoint/fnb/menu-categories"},{"title":"Menu Items","openapi":"GET /fnb/menu-items","href":"/api/endpoint/fnb/menu-items"},{"title":"List Tables","openapi":"GET /fnb/list-tables","href":"/api/endpoint/fnb/list-tables"},{"title":"Get Table","openapi":"GET /fnb/get-table/{tableNumber}","href":"/api/endpoint/fnb/get-table"},{"title":"List Orders","openapi":"GET /fnb/list-orders","href":"/api/endpoint/fnb/list-orders"},{"title":"Get Order","openapi":"GET /fnb/get-order/{orderNumber}","href":"/api/endpoint/fnb/get-order"},{"title":"Create Order","openapi":"POST /fnb/create-order","href":"/api/endpoint/fnb/create-order"},{"title":"Claim Order","openapi":"POST /fnb/claim-order/{orderNumber}","href":"/api/endpoint/fnb/claim-order"},{"title":"Change Order Status","openapi":"POST /fnb/change-order-status/{orderNumber}","href":"/api/endpoint/fnb/change-order-status"},{"title":"Cancel Order","openapi":"POST /fnb/cancel-order/{orderNumber}","href":"/api/endpoint/fnb/cancel-order"},{"title":"Delete Order","openapi":"DELETE /fnb/delete-order/{orderNumber}","href":"/api/endpoint/fnb/delete-order"}]},{"group":"Ranking","pages":[{"title":"Promote User","openapi":"POST /ranking/promote/{userId}","href":"/api/endpoint/ranking/promote-user"},{"title":"Demote User","openapi":"POST /ranking/demote/{userId}","href":"/api/endpoint/ranking/demote-user"},{"title":"Set Rank","openapi":"POST /ranking/set-rank/{userId}/{rankNumber}","href":"/api/endpoint/ranking/set-rank"}]},{"group":"Flights","pages":[{"title":"List Flights","openapi":"GET /flights/list","href":"/api/endpoint/flights/list-flights"},{"title":"Get Flight","openapi":"GET /flights/get/{flightId}","href":"/api/endpoint/flights/get-flight"},{"title":"Flight Board (FIDS)","openapi":"GET /flights/board","href":"/api/endpoint/flights/get-flight-board"},{"title":"Create Flight","openapi":"POST /flights/create","href":"/api/endpoint/flights/create-flight"},{"title":"Update Flight","openapi":"PUT /flights/update/{flightId}","href":"/api/endpoint/flights/update-flight"},{"title":"Change Flight Status","openapi":"POST /flights/change-status/{flightId}","href":"/api/endpoint/flights/change-flight-status"},{"title":"Delete Flight","openapi":"DELETE /flights/delete/{flightId}","href":"/api/endpoint/flights/delete-flight"},{"title":"Book Passenger Seat","openapi":"POST /flights/book-seat","href":"/api/endpoint/flights/book-seat"},{"title":"Cancel / Release Seat","openapi":"POST /flights/cancel-seat","href":"/api/endpoint/flights/cancel-seat"},{"title":"Check Eligibility","openapi":"POST /flights/check-eligibility","href":"/api/endpoint/flights/check-eligibility"},{"title":"Get Flight Settings","openapi":"GET /flights/settings","href":"/api/endpoint/flights/get-flight-settings"},{"title":"Update Flight Settings","openapi":"PUT /flights/settings","href":"/api/endpoint/flights/update-flight-settings"},{"title":"List Airports","openapi":"GET /flights/airports","href":"/api/endpoint/flights/list-airports"},{"title":"List Airlines","openapi":"GET /flights/airlines","href":"/api/endpoint/flights/list-airlines"},{"title":"List Aircraft Fleet","openapi":"GET /flights/aircraft","href":"/api/endpoint/flights/list-aircraft"},{"title":"List Ticket Classes","openapi":"GET /flights/ticket-classes","href":"/api/endpoint/flights/list-ticket-classes"},{"title":"Auto Progress Statuses","openapi":"POST /flights/auto-progress","href":"/api/endpoint/flights/auto-progress"}]},{"group":"Tickets","pages":[{"title":"List Tickets","openapi":"GET /tickets/list","href":"/api/endpoint/tickets/list-tickets"},{"title":"Get Ticket","openapi":"GET /tickets/get/{ticketId}","href":"/api/endpoint/tickets/get-ticket"},{"title":"Create Ticket","openapi":"POST /tickets/create","href":"/api/endpoint/tickets/create-ticket"},{"title":"Create Game Report","openapi":"POST /tickets/create-game-report","href":"/api/endpoint/tickets/create-game-report"},{"title":"Reply as Staff","openapi":"POST /tickets/{ticketId}/reply","href":"/api/endpoint/tickets/reply-staff"},{"title":"Reply as Author","openapi":"POST /tickets/{ticketId}/reply-member","href":"/api/endpoint/tickets/reply-member"},{"title":"Claim Ticket","openapi":"POST /tickets/{ticketId}/claim","href":"/api/endpoint/tickets/claim-ticket"},{"title":"Unclaim Ticket","openapi":"POST /tickets/{ticketId}/unclaim","href":"/api/endpoint/tickets/unclaim-ticket"},{"title":"Change Ticket Status","openapi":"POST /tickets/{ticketId}/status","href":"/api/endpoint/tickets/change-status"},{"title":"Transfer Department","openapi":"POST /tickets/{ticketId}/transfer","href":"/api/endpoint/tickets/transfer-department"},{"title":"Get Configuration","openapi":"GET /tickets/config","href":"/api/endpoint/tickets/get-config"},{"title":"Check User Tickets","openapi":"GET /tickets/check-user-tickets/{userId}","href":"/api/endpoint/tickets/check-user-tickets"}]}]},"basePath":"","title":"Introduction - Series Documentation","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":[],"chunks":[]}