Skip to content

GET /items/{player_identifier}

Endpoint: GET /v1/pdapi/items/<player_identifier>

Auth: Bearer token

Permission: REST.Items.Read

Purpose

Lists the target player's items. Item identifiers in responses can be searched on paldeck.cc/items.

Path parameters

  • player_identifier: UserId or PlayerUID for the target player.

Query parameters

None.

Request body

No request body.

Response schema

200 response schema

Field Type Description
Meta object Target player metadata.
Inventory object Inventory containers for the target player.

Meta object schema:

Field Type Description
PlayerUID string Player UID used by Palworld save data.
Player string Player identifier supplied in the request path.

Inventory object schema:

Field Type Description
Items object Common inventory container.
KeyItems object Key item inventory container.
Weapons object Weapon loadout inventory container.
Armor object Armor inventory container.
Food object Food inventory container.
DropSlot object Drop slot inventory container.

Inventory container object schema:

Field Type Description
Available boolean Whether the container was available.
ContainerID string Palworld container ID, or an empty string when unavailable.
UsedSlots integer Number of occupied slots.
MaxSlots integer Total slot count.
FreeSlots integer Number of free slots.
Slots object Occupied slots keyed by slot index.

Slots item schema:

Field Type Description
ItemID string Palworld item identifier.
Count integer Stack count in the slot.

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 target player, player state, inventory data, or common inventory container could not be resolved.
500 REQUEST_TIMEOUT The internal game-thread callback did not complete within 5 seconds.

Examples

Read inventory for a Steam player

GET /v1/pdapi/items/steam_76561198087654321

Read inventory for a GDK player

GET /v1/pdapi/items/gdk_2533274812345678

Scenarios

  • Check inventory before giving compensation.
  • Confirm an ItemID before using POST /give/items.
  • Troubleshoot reports about missing items.