Classnames

Global classname reference data (read-only).

Endpoints

GET

Methods

Read only

Access

Base path

/api/v1/classnames

Route parameters

Pass public sid values for these route parameters.

{classname}

Example request

curl -X GET 'https://beta.dzconfig.com/api/v1/classnames?per_page=10' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

Endpoints

Method	Path	Purpose
GET	`/api/v1/classnames`	List classnames
GET	`/api/v1/classnames/{classname}`	Get classname details

Query parameters

Parameter	Type	Description
`page`	integer	Page number. Defaults to 1.
`per_page`	integer	Items per page. Values are clamped from 1 to 100.
`search`	string	Match classname or display name.
`category`	integer	Filter by category ID.
`subcategory`	integer	Filter by subcategory ID.
`mod`	integer	Filter by mod ID.
`status`	string	Use enabled or disabled.

Example response

{
    "data": {
        "id": 42,
        "sid": "xK9mPq",
        "name": "AKM",
        "display_name": "AKM",
        "category_id": 1,
        "sub_category_id": 3,
        "mod_id": null,
        "payload": {
            "barrel_length": 415,
            "fire_modes": [
                "auto",
                "semi"
            ]
        },
        "default_type_values": {
            "nominal": 8,
            "min": 4
        },
        "value": 72,
        "has_image": true,
        "is_creature": false,
        "enabled": true,
        "created_at": "2026-01-15T10:30:00.000000Z",
        "updated_at": "2026-04-20T08:15:00.000000Z"
    }
}

Paginated list shape

{
    "data": [
        {
            "sid": "abc123xy",
            "...": "resource fields"
        }
    ],
    "links": {
        "first": "https://beta.dzconfig.com/api/v1/classnames?page=1",
        "last": "https://beta.dzconfig.com/api/v1/classnames?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "per_page": 10,
        "total": 1
    }
}

Status codes

Code	Label	Description
`200`	OK	Returned for successful reads, updates, and deletes.
`401`	Unauthorized	Missing or invalid bearer token.
`403`	Forbidden	Your plan or permissions do not allow this action.
`404`	Not found	The route parameter did not match an accessible resource.
`429`	Rate limited	Too many API requests in a short period.