GET /v1/users/{userId}/items/{itemType}/{itemTargetId}/is-owned — openapi

Gets whether a user owns an item of type itemType with id itemTargetId.

Endpoint

Method: GET

Path: /v1/users/{userId}/items/{itemType}/{itemTargetId}/is-owned

Servers:

https://inventory.roblox.com

Parameters

Name	Location	Required	Description
userId	path	true	ID of the user in question
itemType	path	true	Type of the item in question (i.e. Asset, GamePass, Badge, Bundle)
itemTargetId	path	true	ID of the item in question

[
  {
    "in": "path",
    "name": "userId",
    "description": "ID of the user in question",
    "required": true,
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  },
  {
    "in": "path",
    "name": "itemType",
    "description": "Type of the item in question (i.e. Asset, GamePass, Badge, Bundle)",
    "required": true,
    "schema": {
      "type": "integer",
      "format": "int32",
      "enum": [
        0,
        1,
        2,
        3,
        4
      ]
    }
  },
  {
    "in": "path",
    "name": "itemTargetId",
    "description": "ID of the item in question",
    "required": true,
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  }
]

Responses

Status	Description
200	OK
400	1: The specified user does not exist! 5: The specified game pass does not exist! Are you using the new game pass ID? 6: The specified item type does not exist. 7: The specified Asset does not exist! 10: The specified asset is not a badge! 12: The specified bundle does not exist!

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "type": "boolean"
        }
      },
      "text/json": {
        "schema": {
          "type": "boolean"
        }
      }
    }
  },
  "400": {
    "description": "1: The specified user does not exist!\r\n5: The specified game pass does not exist! Are you using the new game pass ID?\r\n6: The specified item type does not exist.\r\n7: The specified Asset does not exist!\r\n10: The specified asset is not a badge!\r\n12: The specified bundle does not exist!"
  }
}

Authentication

{
  "security": [
    {},
    {
      "roblox-legacy-cookie": []
    }
  ],
  "securitySchemes": {
    "roblox-api-key": {
      "type": "apiKey",
      "description": "A configurable key that allows granular access to Roblox resources. See https://create.roblox.com/docs/cloud/auth/api-keys for more information.",
      "name": "x-api-key",
      "in": "header"
    },
    "roblox-legacy-cookie": {
      "type": "apiKey",
      "description": "A browser cookie that represents the identity of a Roblox user. DO NOT SHARE THIS. Sharing this will allow someone to log in as you and to steal your Robux and items. We do not recommend using cookies to call endpoints. When possible, use API keys with the x-api-key header or OAuth 2.0 instead for authentication.",
      "in": "cookie",
      "name": ".ROBLOSECURITY"
    },
    "roblox-oauth2": {
      "type": "oauth2",
      "description": "Build or authorize apps to access Roblox resources. See https://create.roblox.com/docs/cloud/auth/oauth2-overview for more information.",
      "flows": {
        "authorizationCode": {
          "authorizationUrl": "https://apis.roblox.com/oauth/v1/authorize",
          "tokenUrl": "https://apis.roblox.com/oauth/v1/token",
          "refreshUrl": "https://apis.roblox.com/oauth/v1/token",
          "scopes": {}
        }
      }
    }
  }
}

Complete Operation Definition

{
  "tags": [
    "Inventories",
    "Users"
  ],
  "summary": "Gets whether a user owns an item of type itemType with id itemTargetId.",
  "parameters": [
    {
      "in": "path",
      "name": "userId",
      "description": "ID of the user in question",
      "required": true,
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "in": "path",
      "name": "itemType",
      "description": "Type of the item in question (i.e. Asset, GamePass, Badge, Bundle)",
      "required": true,
      "schema": {
        "type": "integer",
        "format": "int32",
        "enum": [
          0,
          1,
          2,
          3,
          4
        ]
      }
    },
    {
      "in": "path",
      "name": "itemTargetId",
      "description": "ID of the item in question",
      "required": true,
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "boolean"
          }
        },
        "text/json": {
          "schema": {
            "type": "boolean"
          }
        }
      }
    },
    "400": {
      "description": "1: The specified user does not exist!\r\n5: The specified game pass does not exist! Are you using the new game pass ID?\r\n6: The specified item type does not exist.\r\n7: The specified Asset does not exist!\r\n10: The specified asset is not a badge!\r\n12: The specified bundle does not exist!"
    }
  },
  "servers": [
    {
      "url": "https://inventory.roblox.com"
    }
  ],
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {},
    {
      "roblox-legacy-cookie": []
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/inventories#inventory_get_v1_users__userId__items__itemType___itemTargetId__is_owned"
  }
}