Authorizations
Headers
The language to return the communities in. If not provided, the default language for the organisation will be used.
Query Parameters
Required range:
1 <= x <= 100
Required range:
x >= 0
curl --request GET \
--url https://{subdomain}.nudj.cx/api/v2/admin/communities \
--header 'x-api-token: <api-key>'
{
"totalCount": 123,
"edges": [
{
"id": "<string>",
"organisationId": "<string>",
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"communityType": "Artist",
"access": "open",
"status": "archived",
"links": {
"website": "<string>",
"discord": "<string>",
"douyin": "<string>",
"facebook": "<string>",
"instagram": "<string>",
"kuaishou": "<string>",
"linkedin": "<string>",
"messenger": "<string>",
"pinterest": "<string>",
"qq": "<string>",
"qzone": "<string>",
"quora": "<string>",
"reddit": "<string>",
"snapchat": "<string>",
"telegram": "<string>",
"tiktok": "<string>",
"twitter": "<string>",
"wechat": "<string>",
"weibo": "<string>",
"whatsapp": "<string>",
"youtube": "<string>"
},
"style": {
"lightMode": {
"navbarLogo": "<string>",
"logo": "<string>",
"banner": "<string>",
"theme": {},
"customCSS": "<string>",
"favicon": "<string>"
},
"darkMode": {
"navbarLogo": "<string>",
"logo": "<string>",
"banner": "<string>",
"theme": {},
"customCSS": "<string>",
"favicon": "<string>"
},
"general": {
"primaryLanguage": "english"
}
},
"usersWaiting": [
"<string>"
],
"verified": true,
"termsAndConditionsUrl": "<string>",
"privacyPolicyUrl": "<string>",
"additionalInformation": [
{
"variableConfigId": "<string>",
"required": true,
"position": 2
}
],
"bannerTitle": "<string>",
"bannerDescription": "<string>",
"bannerButtonText": "<string>",
"bannerHref": "<string>",
"rules": {
"text": "<string>",
"agreements": [
"<string>"
]
},
"requireMemberRole": true,
"featured": true,
"memberRequirements": [
{
"type": "<string>",
"minimumAge": 123,
"parentManaged": true
}
],
"tags": [
"<string>"
],
"campaigns": [
"<string>"
],
"customTabs": [
{
"title": "<string>",
"url": "<string>",
"opensInNewTab": true,
"position": 2
}
],
"availableAsTemplateForOrganisations": [
"<string>"
],
"isGlobalTemplate": true,
"referralUrlOverride": "<string>",
"startsAt": "<string>",
"expiresAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"communityBackgroundImage": "<string>",
"password": "<string>"
}
]
}
Retrieve a paginated list of communities.
curl --request GET \
--url https://{subdomain}.nudj.cx/api/v2/admin/communities \
--header 'x-api-token: <api-key>'
{
"totalCount": 123,
"edges": [
{
"id": "<string>",
"organisationId": "<string>",
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"communityType": "Artist",
"access": "open",
"status": "archived",
"links": {
"website": "<string>",
"discord": "<string>",
"douyin": "<string>",
"facebook": "<string>",
"instagram": "<string>",
"kuaishou": "<string>",
"linkedin": "<string>",
"messenger": "<string>",
"pinterest": "<string>",
"qq": "<string>",
"qzone": "<string>",
"quora": "<string>",
"reddit": "<string>",
"snapchat": "<string>",
"telegram": "<string>",
"tiktok": "<string>",
"twitter": "<string>",
"wechat": "<string>",
"weibo": "<string>",
"whatsapp": "<string>",
"youtube": "<string>"
},
"style": {
"lightMode": {
"navbarLogo": "<string>",
"logo": "<string>",
"banner": "<string>",
"theme": {},
"customCSS": "<string>",
"favicon": "<string>"
},
"darkMode": {
"navbarLogo": "<string>",
"logo": "<string>",
"banner": "<string>",
"theme": {},
"customCSS": "<string>",
"favicon": "<string>"
},
"general": {
"primaryLanguage": "english"
}
},
"usersWaiting": [
"<string>"
],
"verified": true,
"termsAndConditionsUrl": "<string>",
"privacyPolicyUrl": "<string>",
"additionalInformation": [
{
"variableConfigId": "<string>",
"required": true,
"position": 2
}
],
"bannerTitle": "<string>",
"bannerDescription": "<string>",
"bannerButtonText": "<string>",
"bannerHref": "<string>",
"rules": {
"text": "<string>",
"agreements": [
"<string>"
]
},
"requireMemberRole": true,
"featured": true,
"memberRequirements": [
{
"type": "<string>",
"minimumAge": 123,
"parentManaged": true
}
],
"tags": [
"<string>"
],
"campaigns": [
"<string>"
],
"customTabs": [
{
"title": "<string>",
"url": "<string>",
"opensInNewTab": true,
"position": 2
}
],
"availableAsTemplateForOrganisations": [
"<string>"
],
"isGlobalTemplate": true,
"referralUrlOverride": "<string>",
"startsAt": "<string>",
"expiresAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"communityBackgroundImage": "<string>",
"password": "<string>"
}
]
}
The language to return the communities in. If not provided, the default language for the organisation will be used.
1 <= x <= 100
x >= 0
Was this page helpful?