Skip to content

GET /guilds

Endpoint: GET /v1/pdapi/guilds

Auth: Bearer token

Permission: REST.Guilds.Read

Purpose

Lists known guilds with summary information. Use this endpoint to discover guild IDs before requesting a specific guild.

Path parameters

None.

Query parameters

None.

Request body

No request body.

Response schema

200 response schema

Field Type Description
Meta object Guild list metadata.
Guilds object Known guild summaries keyed by guild UUID.

Meta object schema:

Field Type Description
GuildCount integer Number of guilds returned.

Guild summary object schema:

Field Type Description
name string Guild name.
Level integer Guild base camp level.
admin object Guild admin details.
camp_count integer Number of base camps in the guild.
camps object[] Base camp summaries.
member_count integer Number of guild members.
members string[] Guild member PlayerUID values.

admin object schema:

Field Type Description
id string Admin PlayerUID.
name string Admin player name.

camps[] item schema:

Field Type Description
id string Base camp GUID.
world_pos object Base camp world coordinates.
map_pos object Converted map coordinates.

Coordinate object schema:

Field Type Description
x number X coordinate.
y number Y coordinate.
z number Z coordinate.

Error responses

Error bodies use this shape:

{
    "Error": {
        "Code": "ERROR_CODE",
        "Message": "Human-readable message",
        "Details": {}
    }
}
HTTP Error code When it happens
401 INVALID_TOKEN The Authorization header is missing, malformed, or does not match a configured bearer token.
403 MISSING_PERMISSION The token is valid, but it does not include this endpoint permission.
400 INVALID_JSON A request body was supplied, but it could not be parsed as JSON.
400 REQUEST_FAILED The game-thread callback threw an exception, or a shared player/resource resolver failed.
500 REQUEST_TIMEOUT The internal game-thread callback did not complete within 5 seconds.

Examples

List all guilds

GET /v1/pdapi/guilds

Refresh guild dashboard data

GET /v1/pdapi/guilds

Scenarios

  • Build a guild selector in an admin panel.
  • Find the guild_id for GET /guild.
  • Audit base counts, member counts, and guild ownership at a glance.