Packs

Read an item's states

The states the game draws an item in, as its page's States card lists them: a bow drawn back three ways, a crossbow loaded with an arrow or a firework, a fishing rod cast and so on, with the look each has now. An item with no states (a custom item, which rides paper) answers an empty list.

{item} is the item's name: an item sprite's listing name (with or without its item:), or a 3D item's model name.

GET/packs/{pack}/items/{item}/states

Path parameters

packstringrequired

The pack's slug, as returned by the packs endpoints.

itemstringrequired

The item's name.

Response · 200

The states.

packstringrequired

The pack.

itemstringrequired

The item's name.

targetstringrequired

The vanilla item whose states these are. Null when it has none.

statesarray of objectrequired

One per state.

keystringrequired

Pass as state.

labelstringrequired

What the Studio calls it.

hintstringrequired

When the game draws it.

lookobjectrequired

{model} for another of the pack's models, {sprite: true} for a picture of its own, null for the item's ordinary look.

Error codes

Branch on error.code, never on the message.

invalid_api_key401

The key isn't one of ours, or it has been revoked.

missing_api_key401

No Authorization: Bearer header was sent.

wrong_key_kind401

An MCP key sent to the REST API, or an API key sent to the MCP server. Each only opens its own.

account_suspended403

The account is suspended, so its keys open nothing. message says until when, if the suspension has an end date.

plan_required403

The key is valid, but its account's plan does not include the API.

not_found404

No such pack, asset or job.