---
title: "Get Mod"
method: GET
path: "/mods/{modId}/"
tags: ["WorldBuilder", "public"]
---

# Get Mod

`GET /mods/{modId}/`

Retrieves a mod and its associated content using the mod's `modId`. The response also includes the user's write access permissions for the mod.

## Path parameters

- `modId` string, required

## Query parameters

- `limit` number
- `startAfter` string
- `endBefore` string
- `orderBy` object[]
  - `field` string, required — Field to order by. Allows nesting with dot notation, e.g. if a field is nested in an object, use 'object.field'
  - `direction` union, required — Direction to order by, either 'asc' (Ascending) or 'desc' (Descending)
    - 'asc'
    - 'desc'
- `searchBy` object
  - `field` string — Field to search by. Allows nesting with dot notation, e.g. if a field is nested in an object, use 'object.field'
  - `prefix` string — Prefix to search for. NOTE: Prefix searching is case sensitive.
- `filterBy` object

## Headers

- `x-m2-organization-id` string, required
- `x-m2-project-id` string, required

## Response `200`

The response when getting a mod

- GetModResponseSchema — The response when getting a mod
  - `mod` object, required
    - `modId` string, required — Unique identifier for the mod
    - `name` string, required — Name of the mod
    - `description` string, required — Description of the mod
    - `pictureUrl` string — URL of the mod's picture
    - `liveContentId` string, required — The live content ID associated with the mod
    - `canUserWrite` boolean, required
    - `lastUploadTime` number, required
    - `modContentCount` number, required
  - `content` object[], required
    - `documentId` string, required
    - `description` string, required
    - `status` union, required
      - 0
      - 1
    - `buildId` string, required
    - `creatorId` string, required
    - `pluginName` string, required
    - `maps` object[], required
      - `name` string, required — Name of the map
      - `longPackageName` string, required — Long package name of the map
      - `description` string, required — Description of the map
      - `pictureUrl` string, required — URL of the map's picture
      - `roles` string[]
    - `files` object[], required
      - `name` string, required
      - `platform` string, required
      - `configuration` string
      - `sizeBytes` number, required
      - `md5hash` string, required
      - `metadata` object, required
      - `type` union
        - 'Pak'
        - 'Manifest'
        - 'LatestOnlyPak'
        - 'PakDependency'
    - `patchType` union
      - 'None'
      - 'BasePatch'
      - 'Patch'
    - `createTimeMillis` number, required

## Other responses

- `4XX` — The error object returned by the API when an error occurs

---

[API](https://skmtc.net/otherside/apis/world-builder.md) · [All operations](https://skmtc.net/otherside/apis/world-builder/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/otherside/world-builder/revisions/5b916374c3f8/schema)