POST /v1/catalog/items/details — openapi

Returns details for one or more catalog items.

There is an item count limit per request. Exceeding this returns 400 Bad Request.

Endpoint

Method: POST

Path: /v1/catalog/items/details

Servers:

https://catalog.roblox.com

Request Body

Roblox.Catalog.Api.MultigetItemDetailsRequestModel.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Roblox.Catalog.Api.MultigetItemDetailsRequestModel"
      }
    },
    "text/json": {
      "schema": {
        "$ref": "#/components/schemas/Roblox.Catalog.Api.MultigetItemDetailsRequestModel"
      }
    }
  },
  "description": "Roblox.Catalog.Api.MultigetItemDetailsRequestModel.",
  "required": true
}

Responses

Status	Description
200	OK
400	2: Invalid count
403	0: Token Validation Failed 7: User is unauthorized.
429	8: The flood limit has been exceeded.

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.Catalog.Api.CatalogSearchDetailedResponseItemV2_"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.Catalog.Api.CatalogSearchDetailedResponseItemV2_"
        }
      }
    }
  },
  "400": {
    "description": "2: Invalid count"
  },
  "403": {
    "description": "0: Token Validation Failed\r\n7: User is unauthorized."
  },
  "429": {
    "description": "8: The flood limit has been exceeded."
  }
}

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": [
    "Assets",
    "Avatars"
  ],
  "summary": "Returns details for one or more catalog items.",
  "description": "There is an item count limit per request. Exceeding this returns 400 Bad Request.",
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Catalog.Api.MultigetItemDetailsRequestModel"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Catalog.Api.MultigetItemDetailsRequestModel"
        }
      }
    },
    "description": "Roblox.Catalog.Api.MultigetItemDetailsRequestModel.",
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.Catalog.Api.CatalogSearchDetailedResponseItemV2_"
          }
        },
        "text/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.Catalog.Api.CatalogSearchDetailedResponseItemV2_"
          }
        }
      }
    },
    "400": {
      "description": "2: Invalid count"
    },
    "403": {
      "description": "0: Token Validation Failed\r\n7: User is unauthorized."
    },
    "429": {
      "description": "8: The flood limit has been exceeded."
    }
  },
  "servers": [
    {
      "url": "https://catalog.roblox.com"
    }
  ],
  "x-roblox-stability": "EXPERIMENTAL",
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {},
    {
      "roblox-legacy-cookie": []
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/assets#catalog_post_v1_catalog_items_details"
  }
}