Skip to content
L2NXDev Portal

Item templates (brief)

GET
/gamedata/v1/integration/item-templates
curl --request GET \
  --url 'https://your-tenant.api.l2nx.app/gamedata/v1/integration/item-templates?page=0&size=50' \
  --header 'Authorization: Bearer <token>' \
  --header 'Server-Id: example'

Paginated catalog of visible item templates for the scoped server. Authenticate with the tenant API key as Authorization: Bearer nx_api_... and send Server-Id; the tenant is the one the key belongs to. The key needs the gamedata.item-templates:read scope.

Filters:

  • search — Matches the numeric item id (exact, when the term parses as an int) or a case-insensitive substring of the localized name (ru/en/uk). From 1 character; blank is ignored.
  • id — Exact item-template id, repeatable. Max 200 per request.

Sort: id; default id,ASC

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
search
string

Matches the numeric item id (exact, when the term parses as an int) or a case-insensitive substring of the localized name (ru/en/uk). From 1 character; blank is ignored.

id
Array<integer>

Exact item-template id, repeatable. Max 200 per request.

page
integer
0

Zero-based page index (0..N)

size
integer
default: 50 >= 1

The size of the page to be returned

sort
Array<string>

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Header Parameters

Section titled “Header Parameters”
Server-Id
required
string

Game-server id (UUID) — scopes the data query.

Responses

Section titled “Responses”

200

Section titled “200”

Item-template page

Media type*/*
object
content
Array<object>
object
description

Locale code -> text map. Supported keys: ru, en, uk, es; any of them may be absent on a given row.

object
key
additional properties
string

Example 

{
  "en": "Adena",
  "es": "Adena",
  "ru": "Адена",
  "uk": "Адена"
}
icon
string
iconPanel
string
iconPanelUrl
string
iconUrl
string
id
integer format: int32
name

Locale code -> text map. Supported keys: ru, en, uk, es; any of them may be absent on a given row.

object
key
additional properties
string

Example 

{
  "en": "Adena",
  "es": "Adena",
  "ru": "Адена",
  "uk": "Адена"
}
page
object
number
integer format: int64
size
integer format: int64
totalElements
integer format: int64
totalPages
integer format: int64

400

Section titled “400”

Missing scope headers, server id outside the tenant, or too many ids

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri

Example generated

{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

401

Section titled “401”

Missing / invalid API key

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri

Example generated

{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

403

Section titled “403”

Key revoked or expired (API_KEY_REVOKED, API_KEY_EXPIRED), tenant disabled or mismatched, or the key lacks the gamedata.item-templates:read scope (INSUFFICIENT_SCOPE)

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri

Example generated

{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

404

Section titled “404”

Not Found

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri

Example generated

{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

409

Section titled “409”

Conflict

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri

Example generated

{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

429

Section titled “429”

Per-key rate limit exceeded; Retry-After says when to retry

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri

Example generated

{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

500

Section titled “500”

Internal Server Error

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri

Example generated

{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}