Get Guild by Slug
Retrieve details of a guild by its URL-friendly slug. No authentication required.
Endpoint
GET /api/v2/guilds/slug/:slug
Authentication
This endpoint is public and does not require authentication.
Description
Returns full details of a guild by its unique slug. Slugs are URL-friendly identifiers (e.g., elite-gamers) and are ideal for public-facing guild pages and links.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
slug | string | Yes | URL-friendly identifier for the guild |
Request Example
GET /api/v2/guilds/slug/elite-gamers
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
| Field | Type | Description |
|---|---|---|
id | string | Unique guild identifier |
slug | string | URL-friendly guild identifier |
name | string | Guild name |
description | string | Guild description |
logo | string | Guild logo URL (optional) |
website | string | Guild website URL (optional) |
social | object[] | Social media links (optional) |
size | number | Current member count |
adminId | string | User ID of the guild administrator |
createdAt | number | Creation timestamp (Unix ms) |
updatedAt | number | Last update timestamp (Unix ms) |
Usage Example
// Ideal for public guild pages: /guilds/elite-gamers
const slug = "elite-gamers";
const response = await fetch(`https://api.intraverse.io/api/v2/guilds/slug/${slug}`);
if (response.ok) {
const guild = await response.json();
console.log(`${guild.name} (${guild.size} members)`);
// Build join URL: /guilds/${guild.id}/join
} else {
console.log("Guild not found");
}