Skip to main content

Get Public Guild

Retrieve details of a guild by its ID. No authentication required.

Endpoint

GET /api/v2/guilds/public/:id

Authentication

This endpoint is public and does not require authentication.

Description

Returns full details of a guild by its unique ID. Use this for public guild discovery when you have the guild ID.

Path Parameters

ParameterTypeRequiredDescription
idstringYesUnique identifier for the guild

Request Example

GET /api/v2/guilds/public/guild-123

Response

Success Response (200)

{
"id": "guild-123",
"slug": "elite-gamers",
"name": "Elite Gamers Guild",
"description": "A community for competitive gamers",
"logo": "https://example.com/logo.png",
"website": "https://elitegamers.com",
"social": [
{
"service": "DISCORD",
"username": "elitegamers"
},
{
"service": "TWITTER",
"username": "elitegamers"
}
],
"size": 42,
"adminId": "user-456",
"createdAt": 1672531200000,
"updatedAt": 1704067200000
}

Error Response (404)

{
"message": "Guild not found",
"status": 404
}

Response Fields

FieldTypeDescription
idstringUnique guild identifier
slugstringURL-friendly guild identifier
namestringGuild name
descriptionstringGuild description
logostringGuild logo URL (optional)
websitestringGuild website URL (optional)
socialobject[]Social media links (optional)
sizenumberCurrent member count
adminIdstringUser ID of the guild administrator
createdAtnumberCreation timestamp (Unix ms)
updatedAtnumberLast update timestamp (Unix ms)

Usage Example

const response = await fetch("https://api.intraverse.io/api/v2/guilds/public/guild-123");
const guild = await response.json();

console.log(`${guild.name}: ${guild.description}`);
console.log(`Members: ${guild.size}`);
console.log(`Slug: ${guild.slug}`);

Next Steps