Skip to content

GET /progression/{player_identifier}

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

Auth: Bearer token

Permission: REST.Progression.Read

Purpose

Reads player progression values such as EXP, level-related state, relic totals, and technology point totals.

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.
Progression object Progression, currency, defeat, capture, and activity data.

Meta object schema:

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

Progression object schema:

Field Type Description
Player object Player level, EXP, and unused status points.
Currencies object Relic and technology point totals.
Bosses object Boss defeat counters and flags.
Captures object Pal capture and butcher counters.
Activities object Crafting, dungeon, fishing, treasure, and other activity counters.

Progression.Player object schema:

Field Type Description
level integer Current player level.
exp integer Current EXP value.
unusedStatusPoints integer Unused player status points.

Progression.Currencies object schema:

Field Type Description
relics object Relic point totals keyed by relic type.
technologyPoints integer Technology point total.
ancientTechnologyPoints integer Ancient technology point total.

Progression.Bosses object schema:

Field Type Description
towerBossDefeatCounts object Tower boss defeat counts keyed by boss ID.
normalBossDefeatFlags object Normal boss defeat flags keyed by boss ID.
raidBossDefeatCounts object Raid boss defeat counts keyed by boss ID.
totalBossDefeatCount integer Sum of tower boss defeat counts.
predatorDefeatCount integer Predator defeat count.

Progression.Captures object schema:

Field Type Description
tribeCaptureCount integer Total tribe capture count.
palCaptureCounts object Pal capture counts keyed by Pal ID.
palCaptureBonusCounts object Pal capture bonus counts keyed by Pal ID.
palButcherCounts object Pal butcher counts keyed by Pal ID.

Progression.Activities object schema:

Field Type Description
craftItemCounts object Crafted item counts keyed by item ID.
normalDungeonClearCount integer Normal dungeon clear count.
fixedDungeonClearCount integer Fixed dungeon clear count.
oilrigClearCount integer Oil rig clear count.
palRankUpCounts object Pal rank-up counts keyed by Pal ID.
arenaSoloClearCounts object Arena solo clear counts keyed by arena ID.
npcTalkCounts object NPC talk counts keyed by NPC ID.
fishingCounts object Fishing counts keyed by fish ID.
foundTreasureCount integer Found treasure count.
campConqueredCount integer Camp conquered count.
firstFishingComplete boolean Whether first fishing completion is recorded.

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, account, individual character data, record data, or technology data could not be resolved.
500 REQUEST_TIMEOUT The internal game-thread callback did not complete within 5 seconds.

Examples

Read progression by PS5 UserID

GET /v1/pdapi/progression/ps5_c481a77e22004b9d

Read progression by PlayerUID

GET /v1/pdapi/progression/92b8f6ac-1a3d-4a9e-8f52-cc741db8c20a

Scenarios

  • Confirm the current values before granting progression.
  • Verify a support action after POST /give/progression.
  • Build a player overview panel in a trusted admin dashboard.