Configurable form fields to collect additional user information when joining the community. Each field (e.g., email, phone, address) is defined by a variable config that specifies its type, validation rules, and display order.
A password to access the community. If set then the community will require a password to join.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Nudj Platform Documentation","colors":{"primary":"#8082A6","light":"#AFA9D9","dark":"#BDB7E4"},"logo":{"light":"https://mintcdn.com/nudj/Fh-MK3NeO4rWK1Z6/logo/nudj-logo.png?fit=max\u0026auto=format\u0026n=Fh-MK3NeO4rWK1Z6\u0026q=85\u0026s=7340cd62c3a41730e5ce025fd75c842b","dark":"https://mintcdn.com/nudj/Fh-MK3NeO4rWK1Z6/logo/nudj-dark-logo.png?fit=max\u0026auto=format\u0026n=Fh-MK3NeO4rWK1Z6\u0026q=85\u0026s=8cabc0966dfccab00fad982bcf3b465f"},"favicon":"https://mintcdn.com/nudj/Fh-MK3NeO4rWK1Z6/favicon.ico?fit=max\u0026auto=format\u0026n=Fh-MK3NeO4rWK1Z6\u0026q=85\u0026s=7426330b653f33c458339d01295a6965","api":{"playground":{"display":"interactive"}},"appearance":{"default":"light"},"background":{"color":{"light":"#F5F3FB","dark":"#0F1119"}},"navbar":{"links":[{"href":"mailto:support@nudj.cx","label":"Support"}],"primary":{"type":"button","label":"Get API Tokens","href":"https://admin.nudj.cx/admin/settings/organisation?tab=developer"}},"footer":{"socials":{"x":"https://x.com/nudj","github":"https://github.com/nudj-digital","linkedin":"https://www.linkedin.com/company/nudj"}},"fonts":{"heading":{"family":"Playfair Display","weight":700},"body":{"family":"Outfit","weight":400}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"nudj","hasAudioNarration":false,"actualSubdomain":"nudj","customDomains":["docs.nudj.cx"],"gitSource":{"type":"github","owner":"nudj-digital","repo":"monorepo","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae2174a83326b7b15ea3131","collectionId":"0f9591e5-8c10-41aa-a451-0a3b520f8055","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae2174a83326b7b15ea3131"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae2174a83326b7b15ea3131","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"Admin API","count":235},{"language":"default","tag":"Control Room","count":93},{"language":"default","tag":"Integration API","count":87},{"language":"default","tag":"Analytics API","count":54},{"language":"default","tag":"User Guide","count":41},{"language":"default","tag":"Ways to Engage","count":39},{"language":"default","tag":"Challenges","count":39},{"language":"default","tag":"Rewards","count":30},{"language":"default","tag":"Organization Settings","count":26},{"language":"default","tag":"Developer","count":25}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","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":"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":"llms-txt-v2","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"#content-area a.link{color:#5f6193;text-decoration-color:#5f6193}#content-area a.link:focus-visible,#content-area a.link:hover{color:#4a4c79;text-decoration-color:#4a4c79}.dark #content-area a.link{color:#bdb7e4;text-decoration-color:#bdb7e4}.dark #content-area a.link:focus-visible,.dark #content-area a.link:hover{color:#d4cfee;text-decoration-color:#d4cfee}"}],"page":{"pagePath":"api-reference/admin/get-communities-communityId","slug":"/api-reference/admin/get-communities-communityId","pageMetadata":{"title":"Get community by ID","openapi":"openapi/admin.json GET /communities/{communityId}","description":"Retrieve a community by its ID.","href":"/api-reference/admin/get-communities-communityId"},"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: \"Retrieve a community by its ID.\"\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get community by ID","openapi":"openapi/admin.json GET /communities/{communityId}","description":"Retrieve a community by its ID.","href":"/api-reference/admin/get-communities-communityId"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/nudj/a4881203b9b8dc75/generate-api-docs.js","/_mintlify/custom/nudj/90666c9eadd6f6ca/update-navigation.js","/_mintlify/custom/nudj/cb82a77682afa872/fetch-openapi.js","/_mintlify/custom/nudj/17b922120d4f8afe/fix-navigation.js","/_mintlify/custom/nudj/e3afd7dfb92e6b1b/normalize-openapi.js","/_mintlify/custom/nudj/3e9096727cf1ed8d/restore-general-docs.js","/_mintlify/custom/nudj/05ef9ce7c833cf9b/scripts/generate-all-releases.js","/_mintlify/custom/nudj/e04dda1835326c9c/scripts/sync-highlights-nav.js","/_mintlify/custom/nudj/0a7a1d9fd5d964ad/scripts/sync-releases-nav.js"],"openApiReferenceData":{"operation":{"operationId":"getCommunityById","summary":"Get community by ID","description":"Retrieve a community by its ID.","tags":["Community"],"parameters":["f1842c46-8ed6-4580-bca4-171e59d727af","5f3b9ac5-980e-4051-8737-d7c9f58d3549"],"responses":{"200":"427a8455-1da8-49ec-908a-8f27b2fdf0d0","400":"555422dc-1eec-4dd1-8cc9-ba7b9eeb68cd","404":"37fbbaf7-91f5-4c90-8180-45f3db828216","500":"d2ec0c15-5a34-4d59-8e7d-3a3d24a30b7b"},"method":"get","type":"path","servers":["a3578f1c-2881-4c69-bd19-b47edca235fe"],"security":["0d04aee5-14a8-4cbe-bdea-886653c3f242"],"path":"/communities/{communityId}","baseUrlOptions":["https://{subdomain}.nudj.cx/api/v2/admin"],"title":"Get community by ID","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"f1842c46-8ed6-4580-bca4-171e59d727af":{"in":"path","name":"communityId","schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true},"5f3b9ac5-980e-4051-8737-d7c9f58d3549":{"in":"header","name":"x-language","description":"The language to return the community in. If not provided, the default language for the organisation will be used.","schema":{"type":"string","description":"The language to return the community in. If not provided, the default language for the organisation will be used.","uniqueKey":"","typeLabel":"string"}}},"responses":{"427a8455-1da8-49ec-908a-8f27b2fdf0d0":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","description":"The id of the community","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"organisationId":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","description":"The organisation that the community belongs to","isRequired":true,"uniqueKey":"organisationId","typeLabel":"string"},"name":{"type":"string","description":"The name of the community","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"slug":{"type":"string","description":"The slug of the community in format of only letters and hyphens","isRequired":true,"uniqueKey":"slug","typeLabel":"string"},"communityType":{"type":"string","enum":["Artist","Brand","Business","Cause","Community","Entertainment","Organisation","Place","Product"],"description":"The type of the community","isRequired":true,"uniqueKey":"communityType","typeLabel":"enum\u003cstring>"},"access":{"type":"string","enum":["open","request"],"description":"The access level of the community","isRequired":true,"uniqueKey":"access","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["archived","draft","expired","live","scheduled"],"description":"The status of the community","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"tags":{"type":"array","items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","uniqueKey":"tags.items.[INDEX]","typeLabel":"string"},"description":"An array of objectId tagIds referencing the tags collection","isRequired":true,"uniqueKey":"tags","typeLabel":"string[]"},"campaigns":{"type":"array","items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","uniqueKey":"campaigns.items.[INDEX]","typeLabel":"string"},"description":"An array of objectId campaignIds referencing the campaigns collection","isRequired":true,"uniqueKey":"campaigns","typeLabel":"string[]"},"customTabs":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","minLength":1,"description":"The display title for the tab","isRequired":true,"uniqueKey":"customTabs.items.[INDEX].title","typeLabel":"string"},"url":{"type":"string","format":"uri","description":"The URL the tab navigates to (HTTPS only)","isRequired":true,"uniqueKey":"customTabs.items.[INDEX].url","typeLabel":"string\u003curi>"},"opensInNewTab":{"type":"boolean","description":"Whether the link opens in a new tab","isRequired":true,"uniqueKey":"customTabs.items.[INDEX].opensInNewTab","typeLabel":"boolean"},"position":{"type":"integer","minimum":1,"description":"The order in which the tab appears in the main navigation menu (1-based)","isRequired":true,"uniqueKey":"customTabs.items.[INDEX].position","typeLabel":"integer"}},"required":["title","url","opensInNewTab","position"],"title":"Custom Tab","description":"A custom navigation tab with external link","uniqueKey":"customTabs.items.[INDEX]","typeLabel":"Custom Tab · object"},"maxItems":2,"description":"Array of custom navigation tabs (maximum 2)","isRequired":true,"uniqueKey":"customTabs","typeLabel":"Custom Tab · object[]"},"descriptionConfig":{"oneOf":[{"type":"object","properties":{"content":{"oneOf":[{"type":"string","description":"The description content (HTML/text)","uniqueKey":"descriptionConfig.oneOf.0.content.oneOf.0","typeLabel":"string"},{"type":"null","description":"The description content (HTML/text)","uniqueKey":"descriptionConfig.oneOf.0.content.oneOf.1","typeLabel":"null"}],"uniqueKey":"descriptionConfig.oneOf.0.content","typeLabel":"string | null"},"disableLineClamp":{"oneOf":[{"type":"boolean","description":"When true, shows the full description without line clamping","uniqueKey":"descriptionConfig.oneOf.0.disableLineClamp.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"When true, shows the full description without line clamping","uniqueKey":"descriptionConfig.oneOf.0.disableLineClamp.oneOf.1","typeLabel":"null"}],"uniqueKey":"descriptionConfig.oneOf.0.disableLineClamp","typeLabel":"boolean | null"},"maxLines":{"oneOf":[{"type":"number","minimum":1,"maximum":10,"description":"Maximum number of lines to show before clamping (1-10)","uniqueKey":"descriptionConfig.oneOf.0.maxLines.oneOf.0","typeLabel":"number"},{"type":"null","minimum":1,"maximum":10,"description":"Maximum number of lines to show before clamping (1-10)","uniqueKey":"descriptionConfig.oneOf.0.maxLines.oneOf.1","typeLabel":"null"}],"uniqueKey":"descriptionConfig.oneOf.0.maxLines","typeLabel":"number | null"}},"description":"The description configuration including content and display settings","uniqueKey":"descriptionConfig.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"content":{"oneOf":[{"type":"string","description":"The description content (HTML/text)"},{"type":"null","description":"The description content (HTML/text)"}]},"disableLineClamp":{"oneOf":[{"type":"boolean","description":"When true, shows the full description without line clamping"},{"type":"null","description":"When true, shows the full description without line clamping"}]},"maxLines":{"oneOf":[{"type":"number","minimum":1,"maximum":10,"description":"Maximum number of lines to show before clamping (1-10)"},{"type":"null","minimum":1,"maximum":10,"description":"Maximum number of lines to show before clamping (1-10)"}]}},"description":"The description configuration including content and display settings","uniqueKey":"descriptionConfig.oneOf.1","typeLabel":"null"}],"uniqueKey":"descriptionConfig","typeLabel":"object | null"},"links":{"oneOf":[{"type":"object","title":"Community Links","description":"The links of the community","properties":{"website":{"oneOf":[{"type":"string","format":"uri","description":"The website url of the community","uniqueKey":"links.oneOf.0.website.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"The website url of the community","uniqueKey":"links.oneOf.0.website.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.oneOf.0.website","typeLabel":"string\u003curi> | null"},"discord":{"oneOf":[{"type":"string","format":"uri","description":"The Discord url of the community","uniqueKey":"links.oneOf.0.discord.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"The Discord url of the community","uniqueKey":"links.oneOf.0.discord.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.oneOf.0.discord","typeLabel":"string\u003curi> | null"},"douyin":{"oneOf":[{"type":"string","format":"uri","description":"The Douyin url of the community","uniqueKey":"links.oneOf.0.douyin.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"The Douyin url of the community","uniqueKey":"links.oneOf.0.douyin.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.oneOf.0.douyin","typeLabel":"string\u003curi> | null"},"facebook":{"oneOf":[{"type":"string","format":"uri","description":"The Facebook url of the community","uniqueKey":"links.oneOf.0.facebook.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"The Facebook url of the community","uniqueKey":"links.oneOf.0.facebook.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.oneOf.0.facebook","typeLabel":"string\u003curi> | null"},"instagram":{"oneOf":[{"type":"string","format":"uri","description":"The Instagram url of the community","uniqueKey":"links.oneOf.0.instagram.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"The Instagram url of the community","uniqueKey":"links.oneOf.0.instagram.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.oneOf.0.instagram","typeLabel":"string\u003curi> | null"},"kuaishou":{"oneOf":[{"type":"string","format":"uri","description":"The Kuaishou url of the community","uniqueKey":"links.oneOf.0.kuaishou.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"The Kuaishou url of the community","uniqueKey":"links.oneOf.0.kuaishou.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.oneOf.0.kuaishou","typeLabel":"string\u003curi> | null"},"linkedin":{"oneOf":[{"type":"string","format":"uri","description":"The LinkedIn url of the community","uniqueKey":"links.oneOf.0.linkedin.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"The LinkedIn url of the community","uniqueKey":"links.oneOf.0.linkedin.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.oneOf.0.linkedin","typeLabel":"string\u003curi> | null"},"messenger":{"oneOf":[{"type":"string","format":"uri","description":"The Messenger url of the community","uniqueKey":"links.oneOf.0.messenger.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"The Messenger url of the community","uniqueKey":"links.oneOf.0.messenger.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.oneOf.0.messenger","typeLabel":"string\u003curi> | null"},"pinterest":{"oneOf":[{"type":"string","format":"uri","description":"The Pinterest url of the community","uniqueKey":"links.oneOf.0.pinterest.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"The Pinterest url of the community","uniqueKey":"links.oneOf.0.pinterest.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.oneOf.0.pinterest","typeLabel":"string\u003curi> | null"},"qq":{"oneOf":[{"type":"string","format":"uri","description":"The QQ url of the community","uniqueKey":"links.oneOf.0.qq.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"The QQ url of the community","uniqueKey":"links.oneOf.0.qq.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.oneOf.0.qq","typeLabel":"string\u003curi> | null"},"qzone":{"oneOf":[{"type":"string","format":"uri","description":"The Qzone url of the community","uniqueKey":"links.oneOf.0.qzone.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"The Qzone url of the community","uniqueKey":"links.oneOf.0.qzone.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.oneOf.0.qzone","typeLabel":"string\u003curi> | null"},"quora":{"oneOf":[{"type":"string","format":"uri","description":"The Quora url of the community","uniqueKey":"links.oneOf.0.quora.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"The Quora url of the community","uniqueKey":"links.oneOf.0.quora.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.oneOf.0.quora","typeLabel":"string\u003curi> | null"},"reddit":{"oneOf":[{"type":"string","format":"uri","description":"The Reddit url of the community","uniqueKey":"links.oneOf.0.reddit.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"The Reddit url of the community","uniqueKey":"links.oneOf.0.reddit.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.oneOf.0.reddit","typeLabel":"string\u003curi> | null"},"snapchat":{"oneOf":[{"type":"string","format":"uri","description":"The Snapchat url of the community","uniqueKey":"links.oneOf.0.snapchat.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"The Snapchat url of the community","uniqueKey":"links.oneOf.0.snapchat.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.oneOf.0.snapchat","typeLabel":"string\u003curi> | null"},"telegram":{"oneOf":[{"type":"string","format":"uri","description":"The Telegram url of the community","uniqueKey":"links.oneOf.0.telegram.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"The Telegram url of the community","uniqueKey":"links.oneOf.0.telegram.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.oneOf.0.telegram","typeLabel":"string\u003curi> | null"},"tiktok":{"oneOf":[{"type":"string","format":"uri","description":"The TikTok url of the community","uniqueKey":"links.oneOf.0.tiktok.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"The TikTok url of the community","uniqueKey":"links.oneOf.0.tiktok.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.oneOf.0.tiktok","typeLabel":"string\u003curi> | null"},"twitter":{"oneOf":[{"type":"string","format":"uri","description":"The Twitter url of the community","uniqueKey":"links.oneOf.0.twitter.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"The Twitter url of the community","uniqueKey":"links.oneOf.0.twitter.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.oneOf.0.twitter","typeLabel":"string\u003curi> | null"},"wechat":{"oneOf":[{"type":"string","format":"uri","description":"The WeChat url of the community","uniqueKey":"links.oneOf.0.wechat.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"The WeChat url of the community","uniqueKey":"links.oneOf.0.wechat.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.oneOf.0.wechat","typeLabel":"string\u003curi> | null"},"weibo":{"oneOf":[{"type":"string","format":"uri","description":"The Weibo url of the community","uniqueKey":"links.oneOf.0.weibo.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"The Weibo url of the community","uniqueKey":"links.oneOf.0.weibo.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.oneOf.0.weibo","typeLabel":"string\u003curi> | null"},"whatsapp":{"oneOf":[{"type":"string","format":"uri","description":"The WhatsApp url of the community","uniqueKey":"links.oneOf.0.whatsapp.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"The WhatsApp url of the community","uniqueKey":"links.oneOf.0.whatsapp.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.oneOf.0.whatsapp","typeLabel":"string\u003curi> | null"},"youtube":{"oneOf":[{"type":"string","format":"uri","description":"The YouTube url of the community","uniqueKey":"links.oneOf.0.youtube.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"The YouTube url of the community","uniqueKey":"links.oneOf.0.youtube.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.oneOf.0.youtube","typeLabel":"string\u003curi> | null"}},"uniqueKey":"links.oneOf.0","typeLabel":"Community Links · object"},{"type":"null","description":"The links of the community","uniqueKey":"links.oneOf.1","typeLabel":"null"}],"uniqueKey":"links","typeLabel":"Community Links · object | null"},"style":{"oneOf":[{"type":"object","properties":{"lightMode":{"oneOf":[{"type":"object","properties":{"navbarLogo":{"oneOf":[{"type":"string","uniqueKey":"style.oneOf.0.lightMode.oneOf.0.navbarLogo.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"style.oneOf.0.lightMode.oneOf.0.navbarLogo.oneOf.1","typeLabel":"null"}],"uniqueKey":"style.oneOf.0.lightMode.oneOf.0.navbarLogo","typeLabel":"string | null"},"logo":{"oneOf":[{"type":"string","uniqueKey":"style.oneOf.0.lightMode.oneOf.0.logo.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"style.oneOf.0.lightMode.oneOf.0.logo.oneOf.1","typeLabel":"null"}],"uniqueKey":"style.oneOf.0.lightMode.oneOf.0.logo","typeLabel":"string | null"},"banner":{"oneOf":[{"type":"string","uniqueKey":"style.oneOf.0.lightMode.oneOf.0.banner.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"style.oneOf.0.lightMode.oneOf.0.banner.oneOf.1","typeLabel":"null"}],"uniqueKey":"style.oneOf.0.lightMode.oneOf.0.banner","typeLabel":"string | null"},"theme":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"style.oneOf.0.lightMode.oneOf.0.theme.oneOf.0.additionalProperties","typeLabel":"any"},"uniqueKey":"style.oneOf.0.lightMode.oneOf.0.theme.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{}],"uniqueKey":"style.oneOf.0.lightMode.oneOf.0.theme.oneOf.1.additionalProperties","typeLabel":"any"},"uniqueKey":"style.oneOf.0.lightMode.oneOf.0.theme.oneOf.1","typeLabel":"null"}],"uniqueKey":"style.oneOf.0.lightMode.oneOf.0.theme","typeLabel":"object | null"},"customCSS":{"oneOf":[{"type":"string","uniqueKey":"style.oneOf.0.lightMode.oneOf.0.customCSS.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"style.oneOf.0.lightMode.oneOf.0.customCSS.oneOf.1","typeLabel":"null"}],"uniqueKey":"style.oneOf.0.lightMode.oneOf.0.customCSS","typeLabel":"string | null"},"favicon":{"oneOf":[{"type":"string","uniqueKey":"style.oneOf.0.lightMode.oneOf.0.favicon.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"style.oneOf.0.lightMode.oneOf.0.favicon.oneOf.1","typeLabel":"null"}],"uniqueKey":"style.oneOf.0.lightMode.oneOf.0.favicon","typeLabel":"string | null"}},"uniqueKey":"style.oneOf.0.lightMode.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"navbarLogo":{"oneOf":[{"type":"string"},{"type":"null"}]},"logo":{"oneOf":[{"type":"string"},{"type":"null"}]},"banner":{"oneOf":[{"type":"string"},{"type":"null"}]},"theme":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{}]}},{"type":"null","additionalProperties":{"oneOf":[{}]}}]},"customCSS":{"oneOf":[{"type":"string"},{"type":"null"}]},"favicon":{"oneOf":[{"type":"string"},{"type":"null"}]}},"uniqueKey":"style.oneOf.0.lightMode.oneOf.1","typeLabel":"null"}],"uniqueKey":"style.oneOf.0.lightMode","typeLabel":"object | null"},"darkMode":{"oneOf":[{"type":"object","properties":{"navbarLogo":{"oneOf":[{"type":"string","uniqueKey":"style.oneOf.0.darkMode.oneOf.0.navbarLogo.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"style.oneOf.0.darkMode.oneOf.0.navbarLogo.oneOf.1","typeLabel":"null"}],"uniqueKey":"style.oneOf.0.darkMode.oneOf.0.navbarLogo","typeLabel":"string | null"},"logo":{"oneOf":[{"type":"string","uniqueKey":"style.oneOf.0.darkMode.oneOf.0.logo.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"style.oneOf.0.darkMode.oneOf.0.logo.oneOf.1","typeLabel":"null"}],"uniqueKey":"style.oneOf.0.darkMode.oneOf.0.logo","typeLabel":"string | null"},"banner":{"oneOf":[{"type":"string","uniqueKey":"style.oneOf.0.darkMode.oneOf.0.banner.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"style.oneOf.0.darkMode.oneOf.0.banner.oneOf.1","typeLabel":"null"}],"uniqueKey":"style.oneOf.0.darkMode.oneOf.0.banner","typeLabel":"string | null"},"theme":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"style.oneOf.0.darkMode.oneOf.0.theme.oneOf.0.additionalProperties","typeLabel":"any"},"uniqueKey":"style.oneOf.0.darkMode.oneOf.0.theme.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{}],"uniqueKey":"style.oneOf.0.darkMode.oneOf.0.theme.oneOf.1.additionalProperties","typeLabel":"any"},"uniqueKey":"style.oneOf.0.darkMode.oneOf.0.theme.oneOf.1","typeLabel":"null"}],"uniqueKey":"style.oneOf.0.darkMode.oneOf.0.theme","typeLabel":"object | null"},"customCSS":{"oneOf":[{"type":"string","uniqueKey":"style.oneOf.0.darkMode.oneOf.0.customCSS.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"style.oneOf.0.darkMode.oneOf.0.customCSS.oneOf.1","typeLabel":"null"}],"uniqueKey":"style.oneOf.0.darkMode.oneOf.0.customCSS","typeLabel":"string | null"},"favicon":{"oneOf":[{"type":"string","uniqueKey":"style.oneOf.0.darkMode.oneOf.0.favicon.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"style.oneOf.0.darkMode.oneOf.0.favicon.oneOf.1","typeLabel":"null"}],"uniqueKey":"style.oneOf.0.darkMode.oneOf.0.favicon","typeLabel":"string | null"}},"uniqueKey":"style.oneOf.0.darkMode.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"navbarLogo":{"oneOf":[{"type":"string"},{"type":"null"}]},"logo":{"oneOf":[{"type":"string"},{"type":"null"}]},"banner":{"oneOf":[{"type":"string"},{"type":"null"}]},"theme":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{}]}},{"type":"null","additionalProperties":{"oneOf":[{}]}}]},"customCSS":{"oneOf":[{"type":"string"},{"type":"null"}]},"favicon":{"oneOf":[{"type":"string"},{"type":"null"}]}},"uniqueKey":"style.oneOf.0.darkMode.oneOf.1","typeLabel":"null"}],"uniqueKey":"style.oneOf.0.darkMode","typeLabel":"object | null"},"general":{"oneOf":[{"type":"object","properties":{"primaryLanguage":{"oneOf":[{"type":"string","enum":["english","portuguese"],"uniqueKey":"style.oneOf.0.general.oneOf.0.primaryLanguage.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["english","portuguese"],"uniqueKey":"style.oneOf.0.general.oneOf.0.primaryLanguage.oneOf.1","typeLabel":"null"}],"uniqueKey":"style.oneOf.0.general.oneOf.0.primaryLanguage","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"style.oneOf.0.general.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"primaryLanguage":{"oneOf":[{"type":"string","enum":["english","portuguese"]},{"type":"null","enum":["english","portuguese"]}]}},"uniqueKey":"style.oneOf.0.general.oneOf.1","typeLabel":"null"}],"uniqueKey":"style.oneOf.0.general","typeLabel":"object | null"}},"description":"The style of the community","uniqueKey":"style.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"lightMode":{"oneOf":[{"type":"object","properties":{"navbarLogo":{"oneOf":[{"type":"string"},{"type":"null"}]},"logo":{"oneOf":[{"type":"string"},{"type":"null"}]},"banner":{"oneOf":[{"type":"string"},{"type":"null"}]},"theme":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{}]}},{"type":"null","additionalProperties":{"oneOf":[{}]}}]},"customCSS":{"oneOf":[{"type":"string"},{"type":"null"}]},"favicon":{"oneOf":[{"type":"string"},{"type":"null"}]}}},{"type":"null","properties":{"navbarLogo":{"oneOf":[{"type":"string"},{"type":"null"}]},"logo":{"oneOf":[{"type":"string"},{"type":"null"}]},"banner":{"oneOf":[{"type":"string"},{"type":"null"}]},"theme":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{}]}},{"type":"null","additionalProperties":{"oneOf":[{}]}}]},"customCSS":{"oneOf":[{"type":"string"},{"type":"null"}]},"favicon":{"oneOf":[{"type":"string"},{"type":"null"}]}}}]},"darkMode":{"oneOf":[{"type":"object","properties":{"navbarLogo":{"oneOf":[{"type":"string"},{"type":"null"}]},"logo":{"oneOf":[{"type":"string"},{"type":"null"}]},"banner":{"oneOf":[{"type":"string"},{"type":"null"}]},"theme":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{}]}},{"type":"null","additionalProperties":{"oneOf":[{}]}}]},"customCSS":{"oneOf":[{"type":"string"},{"type":"null"}]},"favicon":{"oneOf":[{"type":"string"},{"type":"null"}]}}},{"type":"null","properties":{"navbarLogo":{"oneOf":[{"type":"string"},{"type":"null"}]},"logo":{"oneOf":[{"type":"string"},{"type":"null"}]},"banner":{"oneOf":[{"type":"string"},{"type":"null"}]},"theme":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{}]}},{"type":"null","additionalProperties":{"oneOf":[{}]}}]},"customCSS":{"oneOf":[{"type":"string"},{"type":"null"}]},"favicon":{"oneOf":[{"type":"string"},{"type":"null"}]}}}]},"general":{"oneOf":[{"type":"object","properties":{"primaryLanguage":{"oneOf":[{"type":"string","enum":["english","portuguese"]},{"type":"null","enum":["english","portuguese"]}]}}},{"type":"null","properties":{"primaryLanguage":{"oneOf":[{"type":"string","enum":["english","portuguese"]},{"type":"null","enum":["english","portuguese"]}]}}}]}},"description":"The style of the community","uniqueKey":"style.oneOf.1","typeLabel":"null"}],"uniqueKey":"style","typeLabel":"object | null"},"usersWaiting":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"usersWaiting.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"The users waiting for approval","uniqueKey":"usersWaiting.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"The users waiting for approval","uniqueKey":"usersWaiting.oneOf.1","typeLabel":"null"}],"uniqueKey":"usersWaiting","typeLabel":"string[] | null"},"verified":{"oneOf":[{"type":"boolean","description":"Whether the community is verified","uniqueKey":"verified.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the community is verified","uniqueKey":"verified.oneOf.1","typeLabel":"null"}],"uniqueKey":"verified","typeLabel":"boolean | null"},"termsAndConditionsUrl":{"oneOf":[{"type":"string","format":"uri","description":"The terms and conditions url of the community","uniqueKey":"termsAndConditionsUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"The terms and conditions url of the community","uniqueKey":"termsAndConditionsUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"termsAndConditionsUrl","typeLabel":"string\u003curi> | null"},"privacyPolicyUrl":{"oneOf":[{"type":"string","format":"uri","description":"The privacy policy url of the community","uniqueKey":"privacyPolicyUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"The privacy policy url of the community","uniqueKey":"privacyPolicyUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"privacyPolicyUrl","typeLabel":"string\u003curi> | null"},"additionalInformation":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"variableConfigId":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","description":"The ID of the variable config that defines the data type, validation rules, and UI rendering","isRequired":true,"uniqueKey":"additionalInformation.oneOf.0.items.[INDEX].variableConfigId","typeLabel":"string"},"required":{"type":"boolean","description":"Whether this variable must be filled out by the user before proceeding","isRequired":true,"uniqueKey":"additionalInformation.oneOf.0.items.[INDEX].required","typeLabel":"boolean"},"position":{"type":"number","minimum":1,"description":"The display order position of this variable in the form or UI","isRequired":true,"uniqueKey":"additionalInformation.oneOf.0.items.[INDEX].position","typeLabel":"number"}},"required":["variableConfigId","required","position"],"title":"Variable Config Reference","description":"A reference to a variable configuration that defines a form field or data collection point, including its display order, requirement status, and validation rules. Used to specify what information to collect from users in forms, communities, and other data collection contexts.","uniqueKey":"additionalInformation.oneOf.0.items.[INDEX]","typeLabel":"Variable Config Reference · object"},"description":"Configurable form fields to collect additional user information when joining the community. Each field (e.g., email, phone, address) is defined by a variable config that specifies its type, validation rules, and display order.","uniqueKey":"additionalInformation.oneOf.0","typeLabel":"Variable Config Reference · object[]"},{"type":"null","items":{"type":"object","properties":{"variableConfigId":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","description":"The ID of the variable config that defines the data type, validation rules, and UI rendering"},"required":{"type":"boolean","description":"Whether this variable must be filled out by the user before proceeding"},"position":{"type":"number","minimum":1,"description":"The display order position of this variable in the form or UI"}},"required":["variableConfigId","required","position"],"title":"Variable Config Reference","description":"A reference to a variable configuration that defines a form field or data collection point, including its display order, requirement status, and validation rules. Used to specify what information to collect from users in forms, communities, and other data collection contexts."},"description":"Configurable form fields to collect additional user information when joining the community. Each field (e.g., email, phone, address) is defined by a variable config that specifies its type, validation rules, and display order.","uniqueKey":"additionalInformation.oneOf.1","typeLabel":"null"}],"uniqueKey":"additionalInformation","typeLabel":"Variable Config Reference · object[] | null"},"bannerTitle":{"oneOf":[{"type":"string","uniqueKey":"bannerTitle.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"bannerTitle.oneOf.1","typeLabel":"null"}],"uniqueKey":"bannerTitle","typeLabel":"string | null"},"bannerDescription":{"oneOf":[{"type":"string","uniqueKey":"bannerDescription.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"bannerDescription.oneOf.1","typeLabel":"null"}],"uniqueKey":"bannerDescription","typeLabel":"string | null"},"bannerButtonText":{"oneOf":[{"type":"string","uniqueKey":"bannerButtonText.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"bannerButtonText.oneOf.1","typeLabel":"null"}],"uniqueKey":"bannerButtonText","typeLabel":"string | null"},"bannerHref":{"oneOf":[{"type":"string","format":"uri","uniqueKey":"bannerHref.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","uniqueKey":"bannerHref.oneOf.1","typeLabel":"null"}],"uniqueKey":"bannerHref","typeLabel":"string\u003curi> | null"},"rules":{"oneOf":[{"type":"object","title":"Community Rules","description":"Community rules with text content and agreement statements","properties":{"text":{"oneOf":[{"type":"string","description":"The text content of the community rules","uniqueKey":"rules.oneOf.0.text.oneOf.0","typeLabel":"string"},{"type":"null","description":"The text content of the community rules","uniqueKey":"rules.oneOf.0.text.oneOf.1","typeLabel":"null"}],"uniqueKey":"rules.oneOf.0.text","typeLabel":"string | null"},"agreements":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"rules.oneOf.0.agreements.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Array of agreement statements that users must accept","uniqueKey":"rules.oneOf.0.agreements.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Array of agreement statements that users must accept","uniqueKey":"rules.oneOf.0.agreements.oneOf.1","typeLabel":"null"}],"uniqueKey":"rules.oneOf.0.agreements","typeLabel":"string[] | null"}},"uniqueKey":"rules.oneOf.0","typeLabel":"Community Rules · object"},{"type":"null","uniqueKey":"rules.oneOf.1","typeLabel":"null"}],"uniqueKey":"rules","typeLabel":"Community Rules · object | null"},"requireMemberRole":{"oneOf":[{"type":"boolean","uniqueKey":"requireMemberRole.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"requireMemberRole.oneOf.1","typeLabel":"null"}],"uniqueKey":"requireMemberRole","typeLabel":"boolean | null"},"featured":{"oneOf":[{"type":"boolean","uniqueKey":"featured.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"featured.oneOf.1","typeLabel":"null"}],"uniqueKey":"featured","typeLabel":"boolean | null"},"memberRequirements":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"object","required":["type","minimumAge","parentManaged"],"properties":{"type":{"type":"string","const":"age-member-requirement","isRequired":true,"uniqueKey":"memberRequirements.oneOf.0.items.[INDEX].oneOf.0.type","typeLabel":"string"},"minimumAge":{"type":"number","isRequired":true,"uniqueKey":"memberRequirements.oneOf.0.items.[INDEX].oneOf.0.minimumAge","typeLabel":"number"},"parentManaged":{"type":"boolean","isRequired":true,"uniqueKey":"memberRequirements.oneOf.0.items.[INDEX].oneOf.0.parentManaged","typeLabel":"boolean"}},"uniqueKey":"memberRequirements.oneOf.0.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","title":"CodeMemberRequirement","description":"A code member requirement","required":["type","accessCodes","usedCodes"],"properties":{"type":{"type":"string","const":"code-member-requirement","isRequired":true,"uniqueKey":"memberRequirements.oneOf.0.items.[INDEX].oneOf.1.type","typeLabel":"string"},"accessCodes":{"type":"array","items":{"type":"string","uniqueKey":"memberRequirements.oneOf.0.items.[INDEX].oneOf.1.accessCodes.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"memberRequirements.oneOf.0.items.[INDEX].oneOf.1.accessCodes","typeLabel":"string[]"},"usedCodes":{"type":"array","items":{"type":"string","uniqueKey":"memberRequirements.oneOf.0.items.[INDEX].oneOf.1.usedCodes.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"memberRequirements.oneOf.0.items.[INDEX].oneOf.1.usedCodes","typeLabel":"string[]"}},"uniqueKey":"memberRequirements.oneOf.0.items.[INDEX].oneOf.1","typeLabel":"CodeMemberRequirement · object"},{"type":"object","required":["type","variableConfigId"],"properties":{"type":{"type":"string","const":"variable-member-requirement","isRequired":true,"uniqueKey":"memberRequirements.oneOf.0.items.[INDEX].oneOf.2.type","typeLabel":"string"},"variableConfigId":{"type":"string","isRequired":true,"uniqueKey":"memberRequirements.oneOf.0.items.[INDEX].oneOf.2.variableConfigId","typeLabel":"string"},"onlyRequiredIf":{"oneOf":[{"type":"array","items":{"type":"string","enum":["minimum-age-not-met","minimum-age-met"],"uniqueKey":"memberRequirements.oneOf.0.items.[INDEX].oneOf.2.onlyRequiredIf.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"memberRequirements.oneOf.0.items.[INDEX].oneOf.2.onlyRequiredIf.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","items":{"type":"string","enum":["minimum-age-not-met","minimum-age-met"]},"uniqueKey":"memberRequirements.oneOf.0.items.[INDEX].oneOf.2.onlyRequiredIf.oneOf.1","typeLabel":"null"}],"uniqueKey":"memberRequirements.oneOf.0.items.[INDEX].oneOf.2.onlyRequiredIf","typeLabel":"enum\u003cstring>[] | null"}},"uniqueKey":"memberRequirements.oneOf.0.items.[INDEX].oneOf.2","typeLabel":"object"}],"uniqueKey":"memberRequirements.oneOf.0.items.[INDEX]","typeLabel":"object · CodeMemberRequirement · object · object"},"uniqueKey":"memberRequirements.oneOf.0","typeLabel":"object · CodeMemberRequirement · object · object[]"},{"type":"null","items":{"oneOf":[{"type":"object","required":["type","minimumAge","parentManaged"],"properties":{"type":{"type":"string","const":"age-member-requirement"},"minimumAge":{"type":"number"},"parentManaged":{"type":"boolean"}}},{"type":"object","title":"CodeMemberRequirement","description":"A code member requirement","required":["type","accessCodes","usedCodes"],"properties":{"type":{"type":"string","const":"code-member-requirement"},"accessCodes":{"type":"array","items":{"type":"string"}},"usedCodes":{"type":"array","items":{"type":"string"}}}},{"type":"object","required":["type","variableConfigId"],"properties":{"type":{"type":"string","const":"variable-member-requirement"},"variableConfigId":{"type":"string"},"onlyRequiredIf":{"oneOf":[{"type":"array","items":{"type":"string","enum":["minimum-age-not-met","minimum-age-met"]}},{"type":"null","items":{"type":"string","enum":["minimum-age-not-met","minimum-age-met"]}}]}}}]},"uniqueKey":"memberRequirements.oneOf.1","typeLabel":"null"}],"uniqueKey":"memberRequirements","typeLabel":"object · CodeMemberRequirement · object · object[] | null"},"availableAsTemplateForOrganisations":{"oneOf":[{"type":"array","items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","uniqueKey":"availableAsTemplateForOrganisations.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"The organisations that the community is available as a template for","uniqueKey":"availableAsTemplateForOrganisations.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"description":"The organisations that the community is available as a template for","uniqueKey":"availableAsTemplateForOrganisations.oneOf.1","typeLabel":"null"}],"uniqueKey":"availableAsTemplateForOrganisations","typeLabel":"string[] | null"},"isGlobalTemplate":{"oneOf":[{"type":"boolean","description":"Whether the community is a global template","uniqueKey":"isGlobalTemplate.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the community is a global template","uniqueKey":"isGlobalTemplate.oneOf.1","typeLabel":"null"}],"uniqueKey":"isGlobalTemplate","typeLabel":"boolean | null"},"referralUrlOverride":{"oneOf":[{"type":"string","format":"uri","description":"The referral url override of the community","uniqueKey":"referralUrlOverride.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"The referral url override of the community","uniqueKey":"referralUrlOverride.oneOf.1","typeLabel":"null"}],"uniqueKey":"referralUrlOverride","typeLabel":"string\u003curi> | null"},"startsAt":{"oneOf":[{"type":"string","description":"The date the community is set to be available publicly","uniqueKey":"startsAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"The date the community is set to be available publicly","uniqueKey":"startsAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"startsAt","typeLabel":"string | null"},"expiresAt":{"oneOf":[{"type":"string","description":"The date the community is set to be unavailable publicly","uniqueKey":"expiresAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"The date the community is set to be unavailable publicly","uniqueKey":"expiresAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"expiresAt","typeLabel":"string | null"},"createdAt":{"oneOf":[{"type":"string","description":"The date the community was created","uniqueKey":"createdAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"The date the community was created","uniqueKey":"createdAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"createdAt","typeLabel":"string | null"},"updatedAt":{"oneOf":[{"type":"string","description":"The date the community was last updated","uniqueKey":"updatedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"The date the community was last updated","uniqueKey":"updatedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"updatedAt","typeLabel":"string | null"},"communityBackgroundImage":{"oneOf":[{"type":"string","format":"uri","description":"Background image URL for the community. Recommended size: 1920x1080px (laptop screen size) or larger for optimal display across devices","uniqueKey":"communityBackgroundImage.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Background image URL for the community. Recommended size: 1920x1080px (laptop screen size) or larger for optimal display across devices","uniqueKey":"communityBackgroundImage.oneOf.1","typeLabel":"null"}],"uniqueKey":"communityBackgroundImage","typeLabel":"string\u003curi> | null"},"password":{"oneOf":[{"type":"string","description":"A password to access the community. If set then the community will require a password to join.","uniqueKey":"password.oneOf.0","typeLabel":"string"},{"type":"null","description":"A password to access the community. If set then the community will require a password to join.","uniqueKey":"password.oneOf.1","typeLabel":"null"}],"uniqueKey":"password","typeLabel":"string | null"}},"required":["id","organisationId","name","slug","communityType","access","status","tags","campaigns","customTabs"],"title":"Community","description":"A community","uniqueKey":"","typeLabel":"Community · object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","organisationId":"\u003cstring>","name":"\u003cstring>","slug":"\u003cstring>","communityType":"Artist","access":"open","status":"archived","tags":["\u003cstring>"],"campaigns":["\u003cstring>"],"customTabs":[{"title":"\u003cstring>","url":"\u003cstring>","opensInNewTab":true,"position":2}],"descriptionConfig":{"content":"\u003cstring>","disableLineClamp":true,"maxLines":5.5},"links":{"website":"\u003cstring>","discord":"\u003cstring>","douyin":"\u003cstring>","facebook":"\u003cstring>","instagram":"\u003cstring>","kuaishou":"\u003cstring>","linkedin":"\u003cstring>","messenger":"\u003cstring>","pinterest":"\u003cstring>","qq":"\u003cstring>","qzone":"\u003cstring>","quora":"\u003cstring>","reddit":"\u003cstring>","snapchat":"\u003cstring>","telegram":"\u003cstring>","tiktok":"\u003cstring>","twitter":"\u003cstring>","wechat":"\u003cstring>","weibo":"\u003cstring>","whatsapp":"\u003cstring>","youtube":"\u003cstring>"},"style":{"lightMode":{"navbarLogo":"\u003cstring>","logo":"\u003cstring>","banner":"\u003cstring>","theme":{},"customCSS":"\u003cstring>","favicon":"\u003cstring>"},"darkMode":{"navbarLogo":"\u003cstring>","logo":"\u003cstring>","banner":"\u003cstring>","theme":{},"customCSS":"\u003cstring>","favicon":"\u003cstring>"},"general":{"primaryLanguage":"english"}},"usersWaiting":["\u003cstring>"],"verified":true,"termsAndConditionsUrl":"\u003cstring>","privacyPolicyUrl":"\u003cstring>","additionalInformation":[{"variableConfigId":"\u003cstring>","required":true,"position":2}],"bannerTitle":"\u003cstring>","bannerDescription":"\u003cstring>","bannerButtonText":"\u003cstring>","bannerHref":"\u003cstring>","rules":{"text":"\u003cstring>","agreements":["\u003cstring>"]},"requireMemberRole":true,"featured":true,"memberRequirements":[{"type":"age-member-requirement","minimumAge":123,"parentManaged":true}],"availableAsTemplateForOrganisations":["\u003cstring>"],"isGlobalTemplate":true,"referralUrlOverride":"\u003cstring>","startsAt":"\u003cstring>","expiresAt":"\u003cstring>","createdAt":"\u003cstring>","updatedAt":"\u003cstring>","communityBackgroundImage":"\u003cstring>","password":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"555422dc-1eec-4dd1-8cc9-ba7b9eeb68cd":{"description":"Invalid input data","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The error message","example":"Invalid input data","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"The error code","example":"BAD_REQUEST","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"issues.items.[INDEX].message","typeLabel":"string"}},"required":["message"],"uniqueKey":"issues.items.[INDEX]","typeLabel":"object"},"description":"An array of issues that were responsible for the error","example":[],"uniqueKey":"issues","typeLabel":"object[]"}},"required":["message","code"],"title":"Error","description":"The error information","example":{"code":"BAD_REQUEST","message":"Invalid input data","issues":[]},"uniqueKey":"","typeLabel":"Error · object"},"examples":{"Example":{"title":"Example","value":{"code":"BAD_REQUEST","message":"Invalid input data","issues":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"37fbbaf7-91f5-4c90-8180-45f3db828216":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The error message","example":"Not found","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"The error code","example":"NOT_FOUND","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"issues.items.[INDEX].message","typeLabel":"string"}},"required":["message"],"uniqueKey":"issues.items.[INDEX]","typeLabel":"object"},"description":"An array of issues that were responsible for the error","example":[],"uniqueKey":"issues","typeLabel":"object[]"}},"required":["message","code"],"title":"Error","description":"The error information","example":{"code":"NOT_FOUND","message":"Not found","issues":[]},"uniqueKey":"","typeLabel":"Error · object"},"examples":{"Example":{"title":"Example","value":{"code":"NOT_FOUND","message":"Not found","issues":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"d2ec0c15-5a34-4d59-8e7d-3a3d24a30b7b":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The error message","example":"Internal server error","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"The error code","example":"INTERNAL_SERVER_ERROR","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"issues.items.[INDEX].message","typeLabel":"string"}},"required":["message"],"uniqueKey":"issues.items.[INDEX]","typeLabel":"object"},"description":"An array of issues that were responsible for the error","example":[],"uniqueKey":"issues","typeLabel":"object[]"}},"required":["message","code"],"title":"Error","description":"The error information","example":{"code":"INTERNAL_SERVER_ERROR","message":"Internal server error","issues":[]},"uniqueKey":"","typeLabel":"Error · object"},"examples":{"Example":{"title":"Example","value":{"code":"INTERNAL_SERVER_ERROR","message":"Internal server error","issues":[]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"0d04aee5-14a8-4cbe-bdea-886653c3f242":{"ApiToken":{"type":"apiKey","in":"header","name":"x-api-token","scopes":[]}}},"servers":{"a3578f1c-2881-4c69-bd19-b47edca235fe":{"url":"https://{subdomain}.nudj.cx/api/v2/admin","description":"Organization API Server","variables":{"subdomain":{"description":"Your organization's subdomain (required)","default":"your-org"}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-token","scopes":[]},"schema":{"title":"x-api-token","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiToken","name":"x-api-token"}],"title":"ApiToken"}]},"originalFileLocation":"openapi/admin.json"},"subdomain":"nudj","siteName":"Nudj Platform Documentation","title":"Get community by ID - Nudj Platform Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-03-24T12:15:50.660Z","originalFileLocation":"api-reference/admin/get-communities-communityId.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=\"light\"}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=\"Retrieve a community by its ID.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Nudj Platform 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/nudj/fATeH148tHvCQ7Cy/_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/nudj/fATeH148tHvCQ7Cy/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/nudj/fATeH148tHvCQ7Cy/_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/nudj/fATeH148tHvCQ7Cy/_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/nudj/fATeH148tHvCQ7Cy/_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/nudj/fATeH148tHvCQ7Cy/_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/nudj/fATeH148tHvCQ7Cy/_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/nudj/fATeH148tHvCQ7Cy/_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/nudj/fATeH148tHvCQ7Cy/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get community by ID - Nudj Platform Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve a community by its ID.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Nudj Platform Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.nudj.cx/api-reference/admin/get-communities-communityId\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://nudj.mintlify.app/_mintlify/api/og/v2?division=Communities\u0026amp;title=Get+community+by+ID\u0026amp;description=Retrieve+a+community+by+its+ID.\u0026amp;theme=b38afa39b71556cd91c41f96\u0026amp;signature=cda63ca50c77cda7a621ee931f430db45c80b6978dcc861fd5610c57ee2535c2\">\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=\"Get community by ID - Nudj Platform Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve a community by its ID.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://nudj.mintlify.app/_mintlify/api/og/v2?division=Communities\u0026amp;title=Get+community+by+ID\u0026amp;description=Retrieve+a+community+by+its+ID.\u0026amp;theme=b38afa39b71556cd91c41f96\u0026amp;signature=cda63ca50c77cda7a621ee931f430db45c80b6978dcc861fd5610c57ee2535c2\">\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/nudj/fATeH148tHvCQ7Cy/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Nudj Platform Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#8082A6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.nudj.cx/api-reference/admin/get-communities-communityId\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/admin/get-communities-communityId.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.nudj.cx/#organization\",\"name\":\"Nudj Platform Documentation\",\"url\":\"https://docs.nudj.cx\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/nudj/Fh-MK3NeO4rWK1Z6/logo/nudj-logo.png?fit=max\u0026auto=format\u0026n=Fh-MK3NeO4rWK1Z6\u0026q=85\u0026s=7340cd62c3a41730e5ce025fd75c842b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.nudj.cx#website\",\"name\":\"Nudj Platform Documentation\",\"url\":\"https://docs.nudj.cx\",\"publisher\":{\"@id\":\"https://docs.nudj.cx/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.nudj.cx/api-reference/admin/get-communities-communityId#webpage\",\"url\":\"https://docs.nudj.cx/api-reference/admin/get-communities-communityId\",\"name\":\"Get community by ID\",\"description\":\"Retrieve a community by its ID.\",\"dateModified\":\"2026-03-24T12:15:50.660Z\",\"isPartOf\":{\"@id\":\"https://docs.nudj.cx#website\"},\"breadcrumb\":{\"@id\":\"https://docs.nudj.cx/api-reference/admin/get-communities-communityId#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.nudj.cx/api-reference/admin/get-communities-communityId#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Communities\",\"item\":\"https://docs.nudj.cx/api-reference/admin/get-communities\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get community by ID\",\"item\":\"https://docs.nudj.cx/api-reference/admin/get-communities-communityId\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.nudj.cx/api-reference/admin/get-communities-communityId#apireference\",\"headline\":\"Get community by ID\",\"name\":\"Get community by ID\",\"description\":\"Retrieve a community by its ID.\",\"url\":\"https://docs.nudj.cx/api-reference/admin/get-communities-communityId\",\"mainEntityOfPage\":{\"@id\":\"https://docs.nudj.cx/api-reference/admin/get-communities-communityId#webpage\"},\"dateModified\":\"2026-03-24T12:15:50.660Z\",\"publisher\":{\"@id\":\"https://docs.nudj.cx/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.nudj.cx#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Nudj Platform Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Nudj Platform Documentation","nav":{"global":null,"tabs":[{"tab":"Start","pages":[{"title":"Start","href":"/introduction"}]},{"tab":"What's New","pages":[{"title":"What's New","href":"/whats-new"}]},{"tab":"User Guide","pages":[{"title":"User Guide","href":"/user-guide/introduction"}]},{"tab":"Control Room","pages":[{"title":"Control Room","href":"/admin-guide/introduction"}]},{"tab":"Enterprise","pages":[{"title":"Enterprise","href":"/enterprise/platform-overview"}]},{"tab":"Shopify","pages":[{"title":"Shopify","href":"/shopify"}]},{"tab":"Developer","pages":[{"title":"Developer","href":"/api-reference/introduction"}]},{"tab":"Integration API","pages":[{"title":"Integration API","href":"/api-reference/integration/get-achievements"}]},{"tab":"Admin API","groups":[{"group":"Achievements","pages":[{"title":"Get paginated achievements","openapi":"openapi/admin.json GET /achievements","href":"/api-reference/admin/get-achievements"},{"title":"Get achievement by ID","openapi":"openapi/admin.json GET /achievements/{achievementId}","href":"/api-reference/admin/get-achievements-achievementId"},{"title":"Get a distribution details for an achievement","openapi":"openapi/admin.json GET /achievements/{achievementId}/distribution","href":"/api-reference/admin/get-achievements-achievementId-distribution"},{"title":"Create a new achievement","openapi":"openapi/admin.json POST /achievements","href":"/api-reference/admin/post-achievements"},{"title":"Assign a distribution details to an achievement","openapi":"openapi/admin.json POST /achievements/{achievementId}/distribution","href":"/api-reference/admin/post-achievements-achievementId-distribution"},{"title":"Update an achievement by id","openapi":"openapi/admin.json POST /achievements/{id}","href":"/api-reference/admin/post-achievements-id"}]},{"group":"Action Participations","pages":[{"title":"Get paginated action participations","openapi":"openapi/admin.json GET /action-participations","href":"/api-reference/admin/get-action-participations"},{"title":"Get action participation by ID","openapi":"openapi/admin.json GET /action-participations/{actionParticipationId}","href":"/api-reference/admin/get-action-participations-actionParticipationId"}]},{"group":"Actions","pages":[{"title":"Delete an action by id","openapi":"openapi/admin.json DELETE /actions/{id}","href":"/api-reference/admin/delete-actions-id"},{"title":"Get paginated actions","openapi":"openapi/admin.json GET /actions","href":"/api-reference/admin/get-actions"},{"title":"Get action by ID","openapi":"openapi/admin.json GET /actions/{actionId}","href":"/api-reference/admin/get-actions-actionId"},{"title":"Get a distribution details for an action","openapi":"openapi/admin.json GET /actions/{actionId}/distribution","href":"/api-reference/admin/get-actions-actionId-distribution"},{"title":"Reorder actions in a challenge","openapi":"openapi/admin.json PATCH /actions/reorder","href":"/api-reference/admin/patch-actions-reorder"},{"title":"Create a new action","openapi":"openapi/admin.json POST /actions","href":"/api-reference/admin/post-actions"},{"title":"Assign a distribution details to an action","openapi":"openapi/admin.json POST /actions/{actionId}/distribution","href":"/api-reference/admin/post-actions-actionId-distribution"},{"title":"Update an action by id","openapi":"openapi/admin.json POST /actions/{id}","href":"/api-reference/admin/post-actions-id"}]},{"group":"Auth Config","pages":[{"title":"Get auth configuration","openapi":"openapi/admin.json GET /auth-config","href":"/api-reference/admin/get-auth-config"},{"title":"Update auth configuration","openapi":"openapi/admin.json PATCH /auth-config","href":"/api-reference/admin/patch-auth-config"},{"title":"Revoke API token","openapi":"openapi/admin.json POST /auth-config/tokens/{tokenId}/revoke","href":"/api-reference/admin/post-auth-config-tokens-tokenId-revoke"}]},{"group":"Campaigns","pages":[{"title":"Get paginated campaigns","openapi":"openapi/admin.json GET /campaigns","href":"/api-reference/admin/get-campaigns"},{"title":"Get campaign by ID","openapi":"openapi/admin.json GET /campaigns/{id}","href":"/api-reference/admin/get-campaigns-id"},{"title":"Update an existing campaign","openapi":"openapi/admin.json PATCH /campaigns/{id}","href":"/api-reference/admin/patch-campaigns-id"},{"title":"Create a new campaign","openapi":"openapi/admin.json POST /campaigns","href":"/api-reference/admin/post-campaigns"}]},{"group":"Challenge Groups","pages":[{"title":"Get paginated challenge groups","openapi":"openapi/admin.json GET /challenge-groups","href":"/api-reference/admin/get-challenge-groups"},{"title":"Get challenge group by ID","openapi":"openapi/admin.json GET /challenge-groups/{id}","href":"/api-reference/admin/get-challenge-groups-id"},{"title":"Update a challenge group by id","openapi":"openapi/admin.json PATCH /challenge-groups/{id}","href":"/api-reference/admin/patch-challenge-groups-id"},{"title":"Create a new challenge group","openapi":"openapi/admin.json POST /challenge-groups","href":"/api-reference/admin/post-challenge-groups"}]},{"group":"Challenges","pages":[{"title":"Get paginated challenges","openapi":"openapi/admin.json GET /challenges","href":"/api-reference/admin/get-challenges"},{"title":"Get challenge by ID","openapi":"openapi/admin.json GET /challenges/{challengeId}","href":"/api-reference/admin/get-challenges-challengeId"},{"title":"Get a distribution details for a challenge","openapi":"openapi/admin.json GET /challenges/{challengeId}/distribution","href":"/api-reference/admin/get-challenges-challengeId-distribution"},{"title":"Create a new challenge","openapi":"openapi/admin.json POST /challenges","href":"/api-reference/admin/post-challenges"},{"title":"Assign a distribution details to a challenge","openapi":"openapi/admin.json POST /challenges/{challengeId}/distribution","href":"/api-reference/admin/post-challenges-challengeId-distribution"},{"title":"Update a challenge by id","openapi":"openapi/admin.json POST /challenges/{id}","href":"/api-reference/admin/post-challenges-id"}]},{"group":"Communities","pages":[{"title":"Get paginated communities","openapi":"openapi/admin.json GET /communities","description":"Retrieve a paginated list of communities.","href":"/api-reference/admin/get-communities"},{"title":"Get community by ID","openapi":"openapi/admin.json GET /communities/{communityId}","href":"/api-reference/admin/get-communities-communityId"},{"title":"Create a new community","openapi":"openapi/admin.json POST /communities","description":"Create a new community.","href":"/api-reference/admin/post-communities"},{"title":"Update a community by id","openapi":"openapi/admin.json POST /communities/{id}","href":"/api-reference/admin/post-communities-id"}]},{"group":"Domains","pages":[{"title":"Get domain configuration","openapi":"openapi/admin.json GET /domains","href":"/api-reference/admin/get-domains"},{"title":"Add a domain","openapi":"openapi/admin.json POST /domains","href":"/api-reference/admin/post-domains"},{"title":"Remove a domain","openapi":"openapi/admin.json POST /domains/remove","href":"/api-reference/admin/post-domains-remove"}]},{"group":"Events","pages":[{"title":"Create a new custom event","openapi":"openapi/admin.json POST /events/custom","href":"/api-reference/admin/post-events-custom"},{"title":"Create a new event link","openapi":"openapi/admin.json POST /events/custom/link","href":"/api-reference/admin/post-events-custom-link"}]},{"group":"Feature Flags","pages":[{"title":"Get all feature flags","openapi":"openapi/admin.json GET /feature-flags","href":"/api-reference/admin/get-feature-flags"},{"title":"Update feature flags","openapi":"openapi/admin.json PATCH /feature-flags","href":"/api-reference/admin/patch-feature-flags"}]},{"group":"Game","pages":[{"title":"Delete a game config by id","openapi":"openapi/admin.json DELETE /game-configs/{id}","href":"/api-reference/admin/delete-game-configs-id"},{"title":"Get paginated game configs","openapi":"openapi/admin.json GET /game-configs","href":"/api-reference/admin/get-game-configs"},{"title":"Get game config by ID","openapi":"openapi/admin.json GET /game-configs/{id}","href":"/api-reference/admin/get-game-configs-id"},{"title":"Update a game config","openapi":"openapi/admin.json PATCH /game-configs/{id}","href":"/api-reference/admin/patch-game-configs-id"},{"title":"Create a game config","openapi":"openapi/admin.json POST /game-configs","href":"/api-reference/admin/post-game-configs"}]},{"group":"Games","pages":[{"title":"Assign distribution details to a game config","openapi":"openapi/admin.json POST /games/{gameConfigId}/distribution","href":"/api-reference/admin/post-games-gameConfigId-distribution"}]},{"group":"Languages","pages":[{"title":"Get language configurations","openapi":"openapi/admin.json GET /languages","href":"/api-reference/admin/get-languages"},{"title":"Update language configuration","openapi":"openapi/admin.json POST /languages/{language}","href":"/api-reference/admin/post-languages-language"}]},{"group":"Leaderboards","pages":[{"title":"Get aggregated leaderboard data","openapi":"openapi/admin.json GET /leaderboards/{configId}/data","href":"/api-reference/admin/get-leaderboards-configId-data"},{"title":"Get paginated leaderboard configurations","openapi":"openapi/admin.json GET /leaderboards/configs","href":"/api-reference/admin/get-leaderboards-configs"},{"title":"Get leaderboard config by ID","openapi":"openapi/admin.json GET /leaderboards/configs/{leaderboardConfigId}","href":"/api-reference/admin/get-leaderboards-configs-leaderboardConfigId"},{"title":"Get distribution details for a leaderboard config","openapi":"openapi/admin.json GET /leaderboards/{leaderboardConfigId}/distribution","href":"/api-reference/admin/get-leaderboards-leaderboardConfigId-distribution"},{"title":"Update a leaderboard configuration","openapi":"openapi/admin.json PATCH /leaderboards/configs/{id}","href":"/api-reference/admin/patch-leaderboards-configs-id"},{"title":"Create a new leaderboard configuration","openapi":"openapi/admin.json POST /leaderboards","href":"/api-reference/admin/post-leaderboards"},{"title":"Create default leaderboard configs","openapi":"openapi/admin.json POST /leaderboards/default","href":"/api-reference/admin/post-leaderboards-default"},{"title":"Assign distribution details to a leaderboard config","openapi":"openapi/admin.json POST /leaderboards/{leaderboardConfigId}/distribution","href":"/api-reference/admin/post-leaderboards-leaderboardConfigId-distribution"}]},{"group":"Legal Policies","pages":[{"title":"Get legal policies","openapi":"openapi/admin.json GET /legal-policies","href":"/api-reference/admin/get-legal-policies"},{"title":"Update legal policies","openapi":"openapi/admin.json PATCH /legal-policies","href":"/api-reference/admin/patch-legal-policies"}]},{"group":"Organisations","pages":[{"title":"Get organisation by ID","openapi":"openapi/admin.json GET /organisations/{organisationId}","href":"/api-reference/admin/get-organisations-organisationId"},{"title":"Update an organisation","openapi":"openapi/admin.json PATCH /organisations/{id}","href":"/api-reference/admin/patch-organisations-id"},{"title":"Create a new organisation","openapi":"openapi/admin.json POST /organisations","href":"/api-reference/admin/post-organisations"}]},{"group":"Posts","pages":[{"title":"Get paginated posts","openapi":"openapi/admin.json GET /posts","href":"/api-reference/admin/get-posts"},{"title":"Get post by id","openapi":"openapi/admin.json GET /posts/{postId}","href":"/api-reference/admin/get-posts-postId"},{"title":"Create a new post","openapi":"openapi/admin.json POST /posts","href":"/api-reference/admin/post-posts"},{"title":"Update a post by id","openapi":"openapi/admin.json POST /posts/{id}","href":"/api-reference/admin/post-posts-id"}]},{"group":"Rewards","pages":[{"title":"Get paginated rewards","openapi":"openapi/admin.json GET /rewards","href":"/api-reference/admin/get-rewards"},{"title":"Get reward by ID","openapi":"openapi/admin.json GET /rewards/{rewardId}","href":"/api-reference/admin/get-rewards-rewardId"},{"title":"Get paginated reward entries for a specific reward","openapi":"openapi/admin.json GET /rewards/{rewardId}/entries","href":"/api-reference/admin/get-rewards-rewardId-entries"},{"title":"Get paginated reward redemption values for a specific reward","openapi":"openapi/admin.json GET /rewards/{rewardId}/redemption-values","href":"/api-reference/admin/get-rewards-rewardId-redemption-values"},{"title":"Create a reward","openapi":"openapi/admin.json POST /rewards","href":"/api-reference/admin/post-rewards"},{"title":"Update a reward by id","openapi":"openapi/admin.json POST /rewards/{id}","href":"/api-reference/admin/post-rewards-id"},{"title":"Process manual reward distribution","openapi":"openapi/admin.json POST /rewards/manual-distribution","href":"/api-reference/admin/post-rewards-manual-distribution"},{"title":"Process manual reward giveaway","openapi":"openapi/admin.json POST /rewards/{rewardId}/process-giveaway","href":"/api-reference/admin/post-rewards-rewardId-process-giveaway"},{"title":"Process reward redemption values from CSV","openapi":"openapi/admin.json POST /rewards/{rewardId}/redemption-values","href":"/api-reference/admin/post-rewards-rewardId-redemption-values"}]},{"group":"Streaks","pages":[{"title":"Get paginated streak configs","openapi":"openapi/admin.json GET /streaks/configs","href":"/api-reference/admin/get-streaks-configs"},{"title":"Get streak config by ID","openapi":"openapi/admin.json GET /streaks/configs/{id}","href":"/api-reference/admin/get-streaks-configs-id"},{"title":"Update a streak config by id","openapi":"openapi/admin.json PATCH /streaks/configs/{id}","href":"/api-reference/admin/patch-streaks-configs-id"}]},{"group":"Tags","pages":[{"title":"Delete a tag by id","openapi":"openapi/admin.json DELETE /tags/{id}","href":"/api-reference/admin/delete-tags-id"},{"title":"Get paginated tags","openapi":"openapi/admin.json GET /tags","href":"/api-reference/admin/get-tags"},{"title":"Get tag by ID","openapi":"openapi/admin.json GET /tags/{id}","href":"/api-reference/admin/get-tags-id"},{"title":"Update a tag by ID","openapi":"openapi/admin.json PATCH /tags/{id}","href":"/api-reference/admin/patch-tags-id"},{"title":"Create a new tag","openapi":"openapi/admin.json POST /tags","href":"/api-reference/admin/post-tags"}]},{"group":"Teams","pages":[{"title":"Remove a user from an organisation","openapi":"openapi/admin.json DELETE /teams/{userId}","href":"/api-reference/admin/delete-teams-userId"},{"title":"Get paginated team members","openapi":"openapi/admin.json GET /teams","href":"/api-reference/admin/get-teams"},{"title":"Invite users to an organisation","openapi":"openapi/admin.json POST /teams/invite","href":"/api-reference/admin/post-teams-invite"}]},{"group":"Templates","pages":[{"title":"Get paginated achievement templates","openapi":"openapi/admin.json GET /templates/achievements","href":"/api-reference/admin/get-templates-achievements"},{"title":"Get paginated action templates","openapi":"openapi/admin.json GET /templates/actions","href":"/api-reference/admin/get-templates-actions"},{"title":"Get paginated challenge templates","openapi":"openapi/admin.json GET /templates/challenges","href":"/api-reference/admin/get-templates-challenges"},{"title":"Get paginated community templates","openapi":"openapi/admin.json GET /templates/communities","href":"/api-reference/admin/get-templates-communities"},{"title":"Get paginated post templates","openapi":"openapi/admin.json GET /templates/posts","href":"/api-reference/admin/get-templates-posts"},{"title":"Get paginated reward templates","openapi":"openapi/admin.json GET /templates/rewards","href":"/api-reference/admin/get-templates-rewards"},{"title":"Create a new entity from a template","openapi":"openapi/admin.json POST /templates/create-entity","href":"/api-reference/admin/post-templates-create-entity"}]},{"group":"Themes","pages":[{"title":"Get theme configuration","openapi":"openapi/admin.json GET /themes","href":"/api-reference/admin/get-themes"},{"title":"Update theme configuration","openapi":"openapi/admin.json PATCH /themes","href":"/api-reference/admin/patch-themes"}]},{"group":"Third Party Config","pages":[{"title":"Get third party configuration","openapi":"openapi/admin.json GET /third-party-config","href":"/api-reference/admin/get-third-party-config"},{"title":"Update third party configuration","openapi":"openapi/admin.json PATCH /third-party-config","href":"/api-reference/admin/patch-third-party-config"},{"title":"Generate Shopify linking code","openapi":"openapi/admin.json POST /third-party-config/initiate-shopify-connection","href":"/api-reference/admin/post-third-party-config-initiate-shopify-connection"}]},{"group":"Users","pages":[{"title":"Delete user personal data","openapi":"openapi/admin.json DELETE /users/{id}","href":"/api-reference/admin/delete-users-id"},{"title":"Get paginated users","openapi":"openapi/admin.json GET /users","href":"/api-reference/admin/get-users"},{"title":"Get user by ID","openapi":"openapi/admin.json GET /users/{id}","href":"/api-reference/admin/get-users-id"},{"title":"Create user","openapi":"openapi/admin.json POST /users","href":"/api-reference/admin/post-users"},{"title":"Manage points transaction","openapi":"openapi/admin.json POST /users/{id}/points-transaction","href":"/api-reference/admin/post-users-id-points-transaction"},{"title":"Sync user to external account","openapi":"openapi/admin.json POST /users/sync-to-external-account","href":"/api-reference/admin/post-users-sync-to-external-account"}]},{"group":"Variables","pages":[{"title":"Get paginated variable configs","openapi":"openapi/admin.json GET /variables","href":"/api-reference/admin/get-variables"},{"title":"Get variable config by ID","openapi":"openapi/admin.json GET /variables/{variableConfigId}","href":"/api-reference/admin/get-variables-variableConfigId"},{"title":"Get paginated variable values for a specific variable config","openapi":"openapi/admin.json GET /variables/{variableConfigId}/values","href":"/api-reference/admin/get-variables-variableConfigId-values"},{"title":"Update an existing variable config","openapi":"openapi/admin.json PATCH /variables/{id}","href":"/api-reference/admin/patch-variables-id"},{"title":"Create a new variable config","openapi":"openapi/admin.json POST /variables","href":"/api-reference/admin/post-variables"}]},{"group":"Webhooks","pages":[{"title":"Get webhook configurations","openapi":"openapi/admin.json GET /webhooks/configs","href":"/api-reference/admin/get-webhooks-configs"},{"title":"Get paginated webhook logs","openapi":"openapi/admin.json GET /webhooks/logs","href":"/api-reference/admin/get-webhooks-logs"},{"title":"Update webhook configurations","openapi":"openapi/admin.json PUT /webhooks/configs","href":"/api-reference/admin/put-webhooks-configs"}]},{"group":"Xp","pages":[{"title":"Get XP configuration","openapi":"openapi/admin.json GET /xp-config","href":"/api-reference/admin/get-xp-config"},{"title":"Update XP configuration","openapi":"openapi/admin.json PATCH /xp-config","href":"/api-reference/admin/patch-xp-config"}]},{"group":"Achievement","pages":[{"title":"Get achievement by ID","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /achievements/{achievementId}","href":"/api-reference/achievement/get-achievement-by-id"},{"title":"Get paginated achievements","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /achievements","href":"/api-reference/achievement/get-paginated-achievements"},{"title":"Create a new achievement","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /achievements","href":"/api-reference/achievement/create-a-new-achievement"},{"title":"Update an achievement by id","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /achievements/{id}","href":"/api-reference/achievement/update-an-achievement-by-id"},{"title":"Get a distribution details for an achievement","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /achievements/{achievementId}/distribution","href":"/api-reference/achievement/get-a-distribution-details-for-an-achievement"},{"title":"Assign a distribution details to an achievement","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /achievements/{achievementId}/distribution","href":"/api-reference/achievement/assign-a-distribution-details-to-an-achievement"}]},{"group":"Action Participation","pages":[{"title":"Get action participation by ID","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /action-participations/{actionParticipationId}","href":"/api-reference/action-participation/get-action-participation-by-id"},{"title":"Get paginated action participations","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /action-participations","href":"/api-reference/action-participation/get-paginated-action-participations"}]},{"group":"Action","pages":[{"title":"Get paginated actions","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /actions","href":"/api-reference/action/get-paginated-actions"},{"title":"Create a new action","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /actions","href":"/api-reference/action/create-a-new-action"},{"title":"Update an action by id","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /actions/{id}","href":"/api-reference/action/update-an-action-by-id"},{"title":"Delete an action by id","deprecated":null,"version":null,"openapi":"/openapi/admin.json delete /actions/{id}","href":"/api-reference/action/delete-an-action-by-id"},{"title":"Get action by ID","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /actions/{actionId}","href":"/api-reference/action/get-action-by-id"},{"title":"Reorder actions in a challenge","deprecated":null,"version":null,"openapi":"/openapi/admin.json patch /actions/reorder","href":"/api-reference/action/reorder-actions-in-a-challenge"},{"title":"Get a distribution details for an action","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /actions/{actionId}/distribution","href":"/api-reference/action/get-a-distribution-details-for-an-action"},{"title":"Assign a distribution details to an action","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /actions/{actionId}/distribution","href":"/api-reference/action/assign-a-distribution-details-to-an-action"}]},{"group":"Auth Config","pages":[{"title":"Get auth configuration","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /auth-config","href":"/api-reference/auth-config/get-auth-configuration"},{"title":"Update auth configuration","deprecated":null,"version":null,"openapi":"/openapi/admin.json patch /auth-config","href":"/api-reference/auth-config/update-auth-configuration"},{"title":"Revoke API token","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /auth-config/tokens/{tokenId}/revoke","href":"/api-reference/auth-config/revoke-api-token"}]},{"group":"Community","pages":[{"title":"Get paginated communities","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /communities","href":"/api-reference/community/get-paginated-communities"},{"title":"Create a new community","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /communities","href":"/api-reference/community/create-a-new-community"},{"title":"Update a community by id","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /communities/{id}","href":"/api-reference/community/update-a-community-by-id"},{"title":"Get community by ID","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /communities/{communityId}","href":"/api-reference/community/get-community-by-id"}]},{"group":"Challenge Group","pages":[{"title":"Get challenge group by ID","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /challenge-groups/{id}","href":"/api-reference/challenge-group/get-challenge-group-by-id"},{"title":"Update a challenge group by id","deprecated":null,"version":null,"openapi":"/openapi/admin.json patch /challenge-groups/{id}","href":"/api-reference/challenge-group/update-a-challenge-group-by-id"},{"title":"Get paginated challenge groups","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /challenge-groups","href":"/api-reference/challenge-group/get-paginated-challenge-groups"},{"title":"Create a new challenge group","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /challenge-groups","href":"/api-reference/challenge-group/create-a-new-challenge-group"}]},{"group":"Challenge","pages":[{"title":"Get challenge by ID","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /challenges/{challengeId}","href":"/api-reference/challenge/get-challenge-by-id"},{"title":"Get paginated challenges","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /challenges","href":"/api-reference/challenge/get-paginated-challenges"},{"title":"Create a new challenge","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /challenges","href":"/api-reference/challenge/create-a-new-challenge"},{"title":"Update a challenge by id","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /challenges/{id}","href":"/api-reference/challenge/update-a-challenge-by-id"},{"title":"Get a distribution details for a challenge","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /challenges/{challengeId}/distribution","href":"/api-reference/challenge/get-a-distribution-details-for-a-challenge"},{"title":"Assign a distribution details to a challenge","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /challenges/{challengeId}/distribution","href":"/api-reference/challenge/assign-a-distribution-details-to-a-challenge"}]},{"group":"Domains","pages":[{"title":"Get domain configuration","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /domains","href":"/api-reference/domains/get-domain-configuration"},{"title":"Add a domain","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /domains","href":"/api-reference/domains/add-a-domain"},{"title":"Remove a domain","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /domains/remove","href":"/api-reference/domains/remove-a-domain"}]},{"group":"Event","pages":[{"title":"Create a new event link","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /events/custom/link","href":"/api-reference/event/create-a-new-event-link"},{"title":"Create a new custom event","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /events/custom","href":"/api-reference/event/create-a-new-custom-event"}]},{"group":"Feature Flags","pages":[{"title":"Get all feature flags","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /feature-flags","href":"/api-reference/feature-flags/get-all-feature-flags"},{"title":"Update feature flags","deprecated":null,"version":null,"openapi":"/openapi/admin.json patch /feature-flags","href":"/api-reference/feature-flags/update-feature-flags"}]},{"group":"Language","pages":[{"title":"Get language configurations","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /languages","href":"/api-reference/language/get-language-configurations"},{"title":"Update language configuration","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /languages/{language}","href":"/api-reference/language/update-language-configuration"}]},{"group":"Leaderboard","pages":[{"title":"Create a new leaderboard configuration","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /leaderboards","href":"/api-reference/leaderboard/create-a-new-leaderboard-configuration"},{"title":"Create default leaderboard configs","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /leaderboards/default","href":"/api-reference/leaderboard/create-default-leaderboard-configs"},{"title":"Get paginated leaderboard configurations","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /leaderboards/configs","href":"/api-reference/leaderboard/get-paginated-leaderboard-configurations"},{"title":"Get leaderboard config by ID","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /leaderboards/configs/{leaderboardConfigId}","href":"/api-reference/leaderboard/get-leaderboard-config-by-id"},{"title":"Export fresh leaderboard rankings","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /leaderboards/export","href":"/api-reference/leaderboard/export-fresh-leaderboard-rankings"},{"title":"Get aggregated leaderboard data","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /leaderboards/{configId}/data","href":"/api-reference/leaderboard/get-aggregated-leaderboard-data"},{"title":"Update a leaderboard configuration","deprecated":null,"version":null,"openapi":"/openapi/admin.json patch /leaderboards/configs/{id}","href":"/api-reference/leaderboard/update-a-leaderboard-configuration"},{"title":"Get distribution details for a leaderboard config","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /leaderboards/{leaderboardConfigId}/distribution","href":"/api-reference/leaderboard/get-distribution-details-for-a-leaderboard-config"},{"title":"Assign distribution details to a leaderboard config","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /leaderboards/{leaderboardConfigId}/distribution","href":"/api-reference/leaderboard/assign-distribution-details-to-a-leaderboard-config"}]},{"group":"Legal Policies","pages":[{"title":"Get legal policies","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /legal-policies","href":"/api-reference/legal-policies/get-legal-policies"},{"title":"Update legal policies","deprecated":null,"version":null,"openapi":"/openapi/admin.json patch /legal-policies","href":"/api-reference/legal-policies/update-legal-policies"}]},{"group":"Organisation","pages":[{"title":"Create a new organisation","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /organisations","href":"/api-reference/organisation/create-a-new-organisation"},{"title":"Get organisation by ID","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /organisations/{organisationId}","href":"/api-reference/organisation/get-organisation-by-id"},{"title":"Update an organisation","deprecated":null,"version":null,"openapi":"/openapi/admin.json patch /organisations/{id}","href":"/api-reference/organisation/update-an-organisation"}]},{"group":"Post","pages":[{"title":"Get paginated posts","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /posts","href":"/api-reference/post/get-paginated-posts"},{"title":"Create a new post","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /posts","href":"/api-reference/post/create-a-new-post"},{"title":"Get post by id","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /posts/{postId}","href":"/api-reference/post/get-post-by-id"},{"title":"Update a post by id","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /posts/{id}","href":"/api-reference/post/update-a-post-by-id"}]},{"group":"Reward","pages":[{"title":"Process manual reward distribution","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /rewards/manual-distribution","href":"/api-reference/reward/process-manual-reward-distribution"},{"title":"Get reward by ID","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /rewards/{rewardId}","href":"/api-reference/reward/get-reward-by-id"},{"title":"Get paginated rewards","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /rewards","href":"/api-reference/reward/get-paginated-rewards"},{"title":"Create a reward","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /rewards","href":"/api-reference/reward/create-a-reward"},{"title":"Get paginated reward entries for a specific reward","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /rewards/{rewardId}/entries","href":"/api-reference/reward/get-paginated-reward-entries-for-a-specific-reward"},{"title":"Get paginated reward redemption values for a specific reward","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /rewards/{rewardId}/redemption-values","href":"/api-reference/reward/get-paginated-reward-redemption-values-for-a-specific-reward"},{"title":"Process reward redemption values from CSV","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /rewards/{rewardId}/redemption-values","href":"/api-reference/reward/process-reward-redemption-values-from-csv"},{"title":"Process manual reward giveaway","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /rewards/{rewardId}/process-giveaway","href":"/api-reference/reward/process-manual-reward-giveaway"},{"title":"Update a reward by id","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /rewards/{id}","href":"/api-reference/reward/update-a-reward-by-id"}]},{"group":"Game Config","pages":[{"title":"Get paginated game configs","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /game-configs","href":"/api-reference/game-config/get-paginated-game-configs"},{"title":"Create a game config","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /game-configs","href":"/api-reference/game-config/create-a-game-config"},{"title":"Get game config by ID","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /game-configs/{id}","href":"/api-reference/game-config/get-game-config-by-id"},{"title":"Delete a game config by id","deprecated":null,"version":null,"openapi":"/openapi/admin.json delete /game-configs/{id}","href":"/api-reference/game-config/delete-a-game-config-by-id"},{"title":"Update a game config","deprecated":null,"version":null,"openapi":"/openapi/admin.json patch /game-configs/{id}","href":"/api-reference/game-config/update-a-game-config"},{"title":"Assign distribution details to a game config","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /games/{gameConfigId}/distribution","href":"/api-reference/game-config/assign-distribution-details-to-a-game-config"}]},{"group":"Streak","pages":[{"title":"Get paginated streak configs","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /streaks/configs","href":"/api-reference/streak/get-paginated-streak-configs"},{"title":"Get streak config by ID","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /streaks/configs/{id}","href":"/api-reference/streak/get-streak-config-by-id"},{"title":"Update a streak config by id","deprecated":null,"version":null,"openapi":"/openapi/admin.json patch /streaks/configs/{id}","href":"/api-reference/streak/update-a-streak-config-by-id"}]},{"group":"Tag","pages":[{"title":"Get paginated tags","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /tags","href":"/api-reference/tag/get-paginated-tags"},{"title":"Create a new tag","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /tags","href":"/api-reference/tag/create-a-new-tag"},{"title":"Get tag by ID","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /tags/{id}","href":"/api-reference/tag/get-tag-by-id"},{"title":"Delete a tag by id","deprecated":null,"version":null,"openapi":"/openapi/admin.json delete /tags/{id}","href":"/api-reference/tag/delete-a-tag-by-id"},{"title":"Update a tag by ID","deprecated":null,"version":null,"openapi":"/openapi/admin.json patch /tags/{id}","href":"/api-reference/tag/update-a-tag-by-id"}]},{"group":"Team","pages":[{"title":"Get paginated team members","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /teams","href":"/api-reference/team/get-paginated-team-members"},{"title":"Invite users to an organisation","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /teams/invite","href":"/api-reference/team/invite-users-to-an-organisation"},{"title":"Remove a user from an organisation","deprecated":null,"version":null,"openapi":"/openapi/admin.json delete /teams/{userId}","href":"/api-reference/team/remove-a-user-from-an-organisation"}]},{"group":"Templates","pages":[{"title":"Create a new entity from a template","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /templates/create-entity","href":"/api-reference/templates/create-a-new-entity-from-a-template"},{"title":"Get paginated community templates","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /templates/communities","href":"/api-reference/templates/get-paginated-community-templates"},{"title":"Get paginated action templates","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /templates/actions","href":"/api-reference/templates/get-paginated-action-templates"},{"title":"Get paginated challenge templates","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /templates/challenges","href":"/api-reference/templates/get-paginated-challenge-templates"},{"title":"Get paginated achievement templates","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /templates/achievements","href":"/api-reference/templates/get-paginated-achievement-templates"},{"title":"Get paginated reward templates","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /templates/rewards","href":"/api-reference/templates/get-paginated-reward-templates"},{"title":"Get paginated post templates","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /templates/posts","href":"/api-reference/templates/get-paginated-post-templates"}]},{"group":"Theme","pages":[{"title":"Get theme configuration","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /themes","href":"/api-reference/theme/get-theme-configuration"},{"title":"Update theme configuration","deprecated":null,"version":null,"openapi":"/openapi/admin.json patch /themes","href":"/api-reference/theme/update-theme-configuration"}]},{"group":"Third Party Config","pages":[{"title":"Get third party configuration","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /third-party-config","href":"/api-reference/third-party-config/get-third-party-configuration"},{"title":"Update third party configuration","deprecated":null,"version":null,"openapi":"/openapi/admin.json patch /third-party-config","href":"/api-reference/third-party-config/update-third-party-configuration"}]},{"group":"Shopify","pages":[{"title":"Generate Shopify linking code","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /third-party-config/initiate-shopify-connection","href":"/api-reference/shopify/generate-shopify-linking-code"}]},{"group":"User","pages":[{"title":"Get paginated users","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /users","href":"/api-reference/user/get-paginated-users"},{"title":"Create user","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /users","href":"/api-reference/user/create-user"},{"title":"Get user by ID","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /users/{id}","href":"/api-reference/user/get-user-by-id"},{"title":"Delete user personal data","deprecated":null,"version":null,"openapi":"/openapi/admin.json delete /users/{id}","href":"/api-reference/user/delete-user-personal-data"},{"title":"Manage points transaction","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /users/{id}/points-transaction","href":"/api-reference/user/manage-points-transaction"},{"title":"Sync user to external account","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /users/sync-to-external-account","href":"/api-reference/user/sync-user-to-external-account"}]},{"group":"Variable","pages":[{"title":"Get paginated variable configs","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /variables","href":"/api-reference/variable/get-paginated-variable-configs"},{"title":"Create a new variable config","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /variables","href":"/api-reference/variable/create-a-new-variable-config"},{"title":"Get paginated variable values for a specific variable config","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /variables/{variableConfigId}/values","href":"/api-reference/variable/get-paginated-variable-values-for-a-specific-variable-config"},{"title":"Get variable config by ID","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /variables/{variableConfigId}","href":"/api-reference/variable/get-variable-config-by-id"},{"title":"Update an existing variable config","deprecated":null,"version":null,"openapi":"/openapi/admin.json patch /variables/{id}","href":"/api-reference/variable/update-an-existing-variable-config"}]},{"group":"Webhooks","pages":[{"title":"Get webhook configurations","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /webhooks/configs","href":"/api-reference/webhooks/get-webhook-configurations"},{"title":"Update webhook configurations","deprecated":null,"version":null,"openapi":"/openapi/admin.json put /webhooks/configs","href":"/api-reference/webhooks/update-webhook-configurations"},{"title":"Get paginated webhook logs","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /webhooks/logs","href":"/api-reference/webhooks/get-paginated-webhook-logs"}]},{"group":"XP Config","pages":[{"title":"Get XP configuration","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /xp-config","href":"/api-reference/xp-config/get-xp-configuration"},{"title":"Update XP configuration","deprecated":null,"version":null,"openapi":"/openapi/admin.json patch /xp-config","href":"/api-reference/xp-config/update-xp-configuration"}]},{"group":"Campaign","pages":[{"title":"Get paginated campaigns","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /campaigns","href":"/api-reference/campaign/get-paginated-campaigns"},{"title":"Create a new campaign","deprecated":null,"version":null,"openapi":"/openapi/admin.json post /campaigns","href":"/api-reference/campaign/create-a-new-campaign"},{"title":"Get campaign by ID","deprecated":null,"version":null,"openapi":"/openapi/admin.json get /campaigns/{id}","href":"/api-reference/campaign/get-campaign-by-id"},{"title":"Update an existing campaign","deprecated":null,"version":null,"openapi":"/openapi/admin.json patch /campaigns/{id}","href":"/api-reference/campaign/update-an-existing-campaign"}]}]},{"tab":"Analytics API","pages":[{"title":"Analytics API","href":"/api-reference/analytics/get-achievements-stats-criteria-completion"}]}]},"basePath":"","title":"Get community by ID - Nudj Platform Documentation","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}