# Item

APIs for managing in-game items owned by users. Items represent digital assets that may exist purely in-game or be eligible for minting as NFTs through the Sverse platform.

## Get item by id

> Get detailed information of a specific item by item instance id

```json
{"openapi":"3.0.3","info":{"title":"Sverse Managed Backend (Server SDK)","version":"1.0.0"},"tags":[{"name":"Item","description":"APIs for managing in-game items owned by users.\nItems represent digital assets that may exist purely in-game\nor be eligible for minting as NFTs through the Sverse platform.\n"}],"servers":[{"url":"https://be.sverse.io","description":"Production Environment"},{"url":"https://sandbox.api.sverse.io","description":"Sandbox / Testing Environment"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"paths":{"/api/private/items/{id}":{"get":{"tags":["Item"],"summary":"Get item by id","description":"Get detailed information of a specific item by item instance id","parameters":[{"name":"id","in":"path","required":true,"description":"Item instance ID","schema":{"type":"string"}},{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"},"description":"API key issued to the Game Studio"}],"responses":{"200":{"description":"Get item successfully","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"data":{"$ref":"#/components/schemas/ItemDetail"}}}}}},"400":{"description":"Bad request – missing or invalid item","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"message":{"type":"string"}}}}}},"401":{"description":"Unauthorized – game not found or invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"message":{"type":"string"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"message":{"type":"string"}}}}}}}}}},"components":{"schemas":{"ItemDetail":{"type":"object","properties":{"id":{"type":"string"},"code":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"category":{"type":"string"},"image":{"type":"string","format":"uri"},"itemDefId":{"type":"string"},"itemId":{"type":"string"},"props":{"type":"object","additionalProperties":true},"mint":{"type":"object","properties":{"isMinted":{"type":"boolean"},"status":{"type":"string"},"chainId":{"type":"string"},"nftAddress":{"type":"string"},"walletAddress":{"type":"string"}}},"listing":{"type":"object","properties":{"isListing":{"type":"boolean"},"price":{"type":"number"}}},"ownership":{"type":"object","properties":{"ownerType":{"type":"string"},"walletOwnerId":{"type":"string"}}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}}}}}
```

## Get items of user

> Get list of items belonging to a specific user with pagination, sorting and filters

```json
{"openapi":"3.0.3","info":{"title":"Sverse Managed Backend (Server SDK)","version":"1.0.0"},"tags":[{"name":"Item","description":"APIs for managing in-game items owned by users.\nItems represent digital assets that may exist purely in-game\nor be eligible for minting as NFTs through the Sverse platform.\n"}],"servers":[{"url":"https://be.sverse.io","description":"Production Environment"},{"url":"https://sandbox.api.sverse.io","description":"Sandbox / Testing Environment"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"paths":{"/api/private/users/{identity}/items":{"get":{"tags":["Item"],"summary":"Get items of user","description":"Get list of items belonging to a specific user with pagination, sorting and filters","parameters":[{"name":"identity","in":"path","required":true,"description":"User identity (userId / walletId / external identity)","schema":{"type":"string"}},{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"sortBy","in":"query","schema":{"type":"string","enum":["created_at","updated_at","name"],"default":"created_at"}},{"name":"order","in":"query","schema":{"type":"string","enum":["asc","desc"],"default":"desc"}},{"name":"filter[category]","in":"query","description":"Filter by item category","schema":{"type":"string"}},{"name":"filter[isMinted]","in":"query","description":"Filter by mint status","schema":{"type":"boolean"}},{"name":"filter[isListing]","in":"query","description":"Filter by listing status","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Get items successfully","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ItemSummary"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}}}}},"400":{"description":"Bad request – missing or invalid item","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"message":{"type":"string"}}}}}},"401":{"description":"Unauthorized – game not found or invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"message":{"type":"string"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"message":{"type":"string"}}}}}}}}}},"components":{"schemas":{"ItemSummary":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"category":{"type":"string"},"mint":{"type":"object","properties":{"isMinted":{"type":"boolean"},"status":{"type":"string"}}},"listing":{"type":"object","properties":{"isListing":{"type":"boolean"},"price":{"type":"number"}}}}},"Pagination":{"type":"object","properties":{"page":{"type":"integer"},"limit":{"type":"integer"},"total":{"type":"integer"}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://sverse-1.gitbook.io/sverse-docs/api-reference/server/item.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.