> ## Documentation Index > Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt > Use this file to discover all available pages before exploring further. # Return a list of Products > Returns a list of Products ## OpenAPI ````yaml /api-reference/platform.yaml get /api/v2/platform/products openapi: 3.0.3 info: title: Platform API contact: name: Vendo Connect Inc. url: https://getvendo.com email: sales@getvendo.com description: Spree Platform API version: v2 servers: - url: http://{defaultHost} variables: defaultHost: default: localhost:3000 security: [] tags: - name: Addresses - name: Adjustments - name: Classifications - name: Countries - name: CMS Pages - name: CMS Sections - name: Digital Assets - name: Digital Links - name: Line Items - name: Menus - name: Menu Items - name: Option Types - name: Option Values - name: Orders - name: Payments - name: Payment Methods - name: Products - name: Promotions - name: Promotion Actions - name: Promotion Categories - name: Promotion Rules - name: Roles - name: Shipments - name: Shipping Categories - name: Shipping Methods - name: States - name: Stock Items - name: Stock Locations - name: Store Credit Categories - name: Store Credit Types - name: Store Credits - name: Tax Categories - name: Tax Rates - name: Taxons - name: Taxonomies - name: Users - name: Variants - name: Vendors - name: Webhook Events - name: Webhook Subscribers - name: Wishlists - name: Wished Items - name: Zones paths: /api/v2/platform/products: get: tags: - Products summary: Return a list of Products description: Returns a list of Products operationId: products-list parameters: - name: page in: query example: 1 schema: type: integer - name: per_page in: query example: 50 schema: type: integer - name: include in: query description: >- Select which associated resources you would like to fetch, see: https://jsonapi.org/format/#fetching-includes example: prices schema: type: string - name: filter[name_eq] in: query description: '' example: Green Toy Boat schema: type: string responses: '200': description: Records returned content: application/vnd.api+json: examples: Example: value: data: - id: '164' type: product attributes: name: Product 1648238 description: >- Expedita a doloribus dolorum possimus architecto eligendi sunt quod. Officiis rerum nostrum incidunt delectus sint reiciendis doloribus ut. Atque voluptate nostrum voluptas unde repellendus. Cum natus a id amet eos eligendi laborum. Minus itaque culpa aliquid repudiandae est odio reiciendis temporibus. Nesciunt cum voluptas veniam excepturi ducimus explicabo recusandae. Error quos voluptate reiciendis numquam dicta. available_on: '2021-11-08T19:34:52.496Z' deleted_at: null slug: product-1648238 meta_description: null meta_keywords: null created_at: '2022-11-08T19:34:52.514Z' updated_at: '2022-11-08T19:34:52.520Z' promotionable: true meta_title: null discontinue_on: null public_metadata: {} private_metadata: {} status: active make_active_at: '2021-11-08T19:34:52.496Z' display_compare_at_price: null display_price: $19.99 purchasable: true in_stock: false backorderable: true available: true currency: USD price: '19.99' compare_at_price: null relationships: tax_category: data: id: '108' type: tax_category primary_variant: data: id: '231' type: variant default_variant: data: id: '231' type: variant variants: data: [] option_types: data: [] product_properties: data: [] taxons: data: [] images: data: [] - id: '165' type: product attributes: name: Product 1653934 description: >- Blanditiis deleniti tempora provident culpa id doloremque. Quibusdam commodi minus magni asperiores nemo odio. Laborum mollitia alias quisquam exercitationem aliquam ex occaecati doloremque. Quos optio voluptatum suscipit soluta assumenda quaerat maxime fugit. In saepe quaerat exercitationem earum sequi. Quidem nesciunt provident dicta explicabo autem nemo sunt. Iusto in provident officiis sed. Eveniet quam distinctio ipsam optio sint. Et autem ducimus vel voluptas facere. Earum inventore ut eum eos numquam. Omnis nam provident atque temporibus. Natus illo voluptas enim ex optio eveniet ullam. Labore repudiandae laudantium non suscipit est quae. Odio provident a ad fuga accusamus distinctio vitae. Doloremque quod similique ipsa quas perferendis rerum earum excepturi. Minus explicabo autem quod incidunt. Earum magnam voluptatem expedita eveniet reiciendis dolores atque et. Inventore odio voluptate dicta dolore natus aut occaecati molestiae. Aut eum consequatur soluta voluptatum animi delectus accusantium asperiores. Facere exercitationem consequuntur adipisci nulla similique perferendis ullam. Illo ad aliquid maiores non ea. available_on: '2021-11-08T19:34:52.538Z' deleted_at: null slug: product-1653934 meta_description: null meta_keywords: null created_at: '2022-11-08T19:34:52.549Z' updated_at: '2022-11-08T19:34:52.555Z' promotionable: true meta_title: null discontinue_on: null public_metadata: {} private_metadata: {} status: active make_active_at: '2021-11-08T19:34:52.538Z' display_compare_at_price: null display_price: $19.99 purchasable: true in_stock: false backorderable: true available: true currency: USD price: '19.99' compare_at_price: null relationships: tax_category: data: id: '108' type: tax_category primary_variant: data: id: '232' type: variant default_variant: data: id: '232' type: variant variants: data: [] option_types: data: [] product_properties: data: [] taxons: data: [] images: data: [] meta: count: 2 total_count: 2 total_pages: 1 links: self: >- http://www.example.com/api/v2/platform/products?page=1&per_page=&include=&filter[name_eq]= next: >- http://www.example.com/api/v2/platform/products?filter%5Bname_eq%5D=&include=&page=1&per_page= prev: >- http://www.example.com/api/v2/platform/products?filter%5Bname_eq%5D=&include=&page=1&per_page= last: >- http://www.example.com/api/v2/platform/products?filter%5Bname_eq%5D=&include=&page=1&per_page= first: >- http://www.example.com/api/v2/platform/products?filter%5Bname_eq%5D=&include=&page=1&per_page= schema: $ref: '#/components/schemas/resources_list' '401': description: Authentication Failed content: application/vnd.api+json: examples: Example: value: error: The access token is invalid schema: $ref: '#/components/schemas/error' security: - bearer_auth: [] components: schemas: resources_list: type: object properties: data: type: array items: allOf: - $ref: '#/components/schemas/resource_properties' meta: type: object properties: count: type: integer total_count: type: integer total_pages: type: integer required: - count - total_count - total_pages links: type: object properties: self: type: string next: type: string prev: type: string last: type: string first: type: string required: - self - next - prev - last - first required: - data - meta - links x-internal: false error: type: object properties: error: type: string required: - error x-internal: false resource_properties: type: object properties: id: type: string type: type: string attributes: type: object relationships: type: object required: - id - type - attributes x-internal: false securitySchemes: bearer_auth: type: http scheme: bearer ````