Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Greens-Organization/pz-packs/llms.txt

Use this file to discover all available pages before exploring further.

List Mods

List all mods with pagination, search, and filtering capabilities. No authentication required.

Query Parameters

page
string
default:"1"
Page number for pagination
limit
string
default:"10"
Number of items per page
Search term to filter mods by name or description
sortBy
string
default:"createdAt"
Field to sort by: createdAt, updatedAt, or name
sortOrder
string
default:"asc"
Sort order: asc or desc
tags
string | array
Filter by tags (comma-separated string or array of tag IDs)

Response

data
array
pagination
object
page
number
Current page number
limit
number
Items per page
total
number
Total number of items
curl -X GET "https://api.pzpacks.com/mods?page=1&limit=20&search=hydrocraft&tags=crafting,survival"
{
  "data": [
    {
      "id": "mod-uuid-1",
      "name": "Hydrocraft",
      "workshopId": "2898758886",
      "steamModId": ["Hydrocraft"],
      "description": "Massive crafting expansion for Project Zomboid",
      "steamUrl": "https://steamcommunity.com/sharedfiles/filedetails/?id=2898758886",
      "avatarUrl": "https://example.com/hydrocraft.jpg",
      "mapFolders": [],
      "requiredMods": [],
      "tags": ["tag-uuid-1", "tag-uuid-2"],
      "isActive": true,
      "createdAt": "2024-01-10T08:00:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150
  }
}

Get Mod by ID

Get detailed information about a specific mod by its UUID. No authentication required.

Path Parameters

id
string
required
Mod UUID

Response

id
string
Mod UUID
name
string
Mod name
workshopId
string
Steam Workshop ID
steamModId
array
Array of Steam mod IDs
description
string
Full mod description
steamUrl
string
Steam Workshop page URL
avatarUrl
string
Mod avatar/thumbnail URL
mapFolders
array
Array of map folder names (for map mods)
requiredMods
array
Array of required mod IDs (dependencies)
tags
array
Array of tag UUIDs
highlights
array
Array of highlight strings
curl -X GET "https://api.pzpacks.com/mods/mod-uuid-1"
{
  "id": "mod-uuid-1",
  "name": "Hydrocraft",
  "workshopId": "2898758886",
  "steamModId": ["Hydrocraft"],
  "description": "Massive crafting expansion for Project Zomboid",
  "steamUrl": "https://steamcommunity.com/sharedfiles/filedetails/?id=2898758886",
  "avatarUrl": "https://example.com/hydrocraft.jpg",
  "mapFolders": [],
  "requiredMods": [],
  "tags": ["tag-uuid-1", "tag-uuid-2"],
  "highlights": ["1000+ new items", "Advanced crafting"],
  "isActive": true,
  "createdAt": "2024-01-10T08:00:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

Get Mod by Workshop ID

Get mod information by Steam Workshop ID. No authentication required.

Path Parameters

workshopId
string
required
Steam Workshop ID (e.g., “2898758886”)

Response

Returns the same mod object structure as “Get Mod by ID”.
curl -X GET "https://api.pzpacks.com/mods/workshop/2898758886"
{
  "id": "mod-uuid-1",
  "name": "Hydrocraft",
  "workshopId": "2898758886",
  "steamModId": ["Hydrocraft"],
  "description": "Massive crafting expansion for Project Zomboid",
  "steamUrl": "https://steamcommunity.com/sharedfiles/filedetails/?id=2898758886",
  "avatarUrl": "https://example.com/hydrocraft.jpg",
  "isActive": true,
  "createdAt": "2024-01-10T08:00:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

Update Mod

Update mod information. Requires admin permissions.

Path Parameters

id
string
required
Mod UUID

Body Parameters

All fields are optional. Only include fields you want to update.
name
string
Mod name
description
string
Mod description
steamUrl
string
Steam Workshop page URL
avatarUrl
string
Mod avatar/thumbnail URL
mapFolders
array
Array of map folder names (strings)
requiredMods
array
Array of required mod IDs (strings)
tags
array
Array of tag IDs (strings)
steamModId
array
Array of Steam mod IDs (strings)
workshopId
string
Steam Workshop ID
curl -X PATCH "https://api.pzpacks.com/mods/mod-uuid-1" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Hydrocraft - Updated",
    "description": "Updated description for Hydrocraft mod",
    "tags": ["tag-uuid-1", "tag-uuid-2"]
  }'
{
  "id": "mod-uuid-1",
  "name": "Hydrocraft - Updated",
  "description": "Updated description for Hydrocraft mod",
  "workshopId": "2898758886",
  "steamModId": ["Hydrocraft"],
  "tags": ["tag-uuid-1", "tag-uuid-2"],
  "updatedAt": "2024-01-17T10:00:00Z"
}

Update All Mods

Trigger an update of all mods from Steam Workshop. This is an asynchronous operation that updates mod information from Steam. Requires admin permissions.

Response

message
string
Status message
status
string
Job status (typically “started” or “pending”)
curl -X POST "https://api.pzpacks.com/mods/update-all" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "message": "Mod update job started",
  "status": "started"
}

List Tags

List all available mod tags. No authentication required.

Response

tags
array
curl -X GET "https://api.pzpacks.com/mods/tags"
{
  "tags": [
    {
      "id": "tag-uuid-1",
      "name": "Crafting",
      "slug": "crafting",
      "count": 45
    },
    {
      "id": "tag-uuid-2",
      "name": "Survival",
      "slug": "survival",
      "count": 78
    },
    {
      "id": "tag-uuid-3",
      "name": "Weapons",
      "slug": "weapons",
      "count": 62
    }
  ]
}