GET
/
item-instances
curl --request GET \
  --url https://forgegames.org/api/item-instances \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "id": "<string>",
    "item": {
      "id": "<string>",
      "name": "<string>",
      "thumbnail": "<string>",
      "rollNumerator": 123,
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "teamId": "<string>"
    },
    "itemInstanceSpace": {
      "id": "<string>",
      "itemInstanceId": "<string>",
      "teamUserSpaceId": "<string>",
      "spacePositionX": 123,
      "spacePositionY": 123,
      "teamId": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    },
    "classifiers": [
      {
        "id": "<string>",
        "name": "<string>",
        "classifierOption": {
          "id": "<string>",
          "name": "<string>"
        }
      }
    ],
    "attributes": [
      {
        "id": "<string>",
        "attributeId": "<string>",
        "name": "<string>",
        "value": 123,
        "min": 123,
        "max": 123
      }
    ]
  }
]

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

​
userId
string
​
userSpaceId
string
​
itemId
string
​
instanceIds
string[]
​
classifierOptionIds
string[]

Response

200
application/json
Successful response
​
id
string
required
​
item
object
required
​
itemInstanceSpace
object | null
required
​
classifiers
object[]
required
​
attributes
object[]
required