Get Community

get https://api.nodecraft.studio/v1/community/{community_id}

Get page details for a community.

Responses

Response body

object

code

string

required

discovery.community.success

message

string

required

Successfully retrieved community.

success

boolean

required

true

data

object

required

A community acts as a group of multiple servers.

uuid

required

UUID of the ban

title

string

required

length ≤ 128

Short human readable title

summary

string | null

required

One line attention grabber

image_avatar

string | null

required

URL to a Square aspect (1:1) image to represent the community

description

string | null

required

HTML, plaintext, or markdown content for the main page content.

image_banner

string | null

required

URL to a wide aspect (4:1) banner shown at the top of the page

image_background

string | null

required

URL to 16:9 background image shown on join queue loading pages

rules

string | null

required

HTML, plaintext, or markdown content for the combined rules for the server, community (if apart of one), the platform, and the Nodecraft Community Rules.

tags

array of strings | null

required

List of tags to help categorize the server/community.

Tags*

social_twitter

string | null

required

social_youtube

string | null

required

social_twitch

string | null

required

social_discord

string | null

required

social_store

string | null

required

social_website

string | null

required

social_custom

array of strings | null

required

List of other custom links to show on the page.

Custom URLs*

error

boolean

required

Language

Credentials

Header

Request


xxxxxxxxxx
1
GET /v1/community/community_id?content_format=text HTTP/1.1
2
Accept: application/json
3
Host: api.nodecraft.studio
4
5


xxxxxxxxxx
28
 
1
{
2
  "code": "discovery.community.success",
3
  "message": "Successfully retrieved community.",
4
  "success": true,
5
  "data": {
6
    "id": "00000000-0000-0000-0000-000000000000",
7
    "title": "Gamecraft Community",
8
    "summary": "This is a short summary of the community",
9
    "image_avatar": "https://nodecraft.com/image.png",
10
    "description": "Welcome to the <strong>best</strong> server ever!",
11
    "image_banner": "https://nodecraft.com/image.png",
12
    "image_background": null,
13
    "rules": " - Be nice to each other!\n - no griefing!\n - no cheating!",
14
    "tags": [
15
      "pvp",
16
      "creative",
17
      "skyblock"
18
    ],
19
    "social_twitter": null,
20
    "social_youtube": null,
21
    "social_twitch": null,
22
    "social_discord": null,
23
    "social_store": null,
24
    "social_website": null,
25
    "social_custom": null
26
  },
27
  "error": false
28
}

200

401

404