Skip to main content
GET
/
api
/
public
/
v1
/
community-servers
/
lookup
Lookup Community Server Jsonapi
curl --request GET \
  --url https://api.example.com/api/public/v1/community-servers/lookup \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "<string>",
    "attributes": {
      "platform": "<string>",
      "platform_community_server_id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "is_active": true,
      "is_public": true,
      "flashpoint_detection_enabled": false,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "type": "community-servers"
  },
  "jsonapi": {
    "version": "1.1"
  },
  "links": {
    "self_": "<string>",
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next_": "<string>",
    "describedby": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-API-Key
string | null

Query Parameters

​
platform
string
default:discord

Platform type

​
platform_community_server_id
string
required

Platform-specific ID (e.g., Discord guild ID)

Response

Successful Response

JSON:API response for a single community server resource.

​
data
CommunityServerResource · object
required

JSON:API resource object for a community server.

​
jsonapi
Jsonapi · object
​
links
JSONAPILinks · object

JSON:API links object for pagination and resource links.

Uses field aliases for 'self' and 'next' which are Python reserved words. Always use by_alias=True when serializing. Includes JSON:API 1.1 'describedby' link for API documentation.