Skip to content

@lands.io/mod-sdk / ClanDetails

Interface: ClanDetails

Detailed clan information including members and applications Returned by getById endpoint

Hierarchy

ClanDetails

Table of contents

Properties

Properties

applications

applications: { answers?: string[] ; appliedAt: Date ; id: string ; playerId: string ; playerName: string ; status: string }[]

Pending applications


createdAt

createdAt: Date

Creation timestamp

Inherited from

ClanInfo.createdAt


description

Optional description: string

Optional description

Inherited from

ClanInfo.description


discord

Optional discord: string

Optional Discord invite link

Inherited from

ClanInfo.discord


id

id: string

Unique clan ID

Inherited from

ClanInfo.id


joinType

joinType: string

Join type: 'open', 'approval', 'invite'

Inherited from

ClanInfo.joinType


level

level: number

Clan level

Inherited from

ClanInfo.level


memberCount

memberCount: number

Number of members

Inherited from

ClanInfo.memberCount


members

members: { joinedAt: Date ; playerId: string ; playerName: string ; role: string }[]

Clan members with roles


name

name: string

Clan name

Inherited from

ClanInfo.name


tag

tag: string

Clan tag (max 6 characters)

Inherited from

ClanInfo.tag


Source Code

View full implementation
/**
 * Detailed clan information including members and applications
 * Returned by getById endpoint
 */
export interface ClanDetails extends ClanInfo {
  /** Clan members with roles */
  members: Array<{
    /** Player ID */
    playerId: string;
    /** Player display name */
    playerName: string;
    /** Member role: 'owner', 'moderator', 'member' */
    role: string;
    /** When they joined */
    joinedAt: Date;
  }>;
  /** Pending applications */
  applications: Array<{
    /** Application ID */
    id: string;
    /** Applicant player ID */
    playerId: string;
    /** Applicant display name */
    playerName: string;
    /** Answers to application questions */
    answers?: string[];
    /** When they applied */
    appliedAt: Date;
    /** Application status */
    status: string;
  }>;
}