> ## 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. # List all Taxons > Returns a list of Taxons. [Read more about Taxons](/developer/core-concepts/products#taxons-and-taxonomies) ## OpenAPI ````yaml /api-reference/storefront.yaml get /api/v2/storefront/taxons openapi: 3.0.3 info: version: 2.0.0 title: Storefront API description: >- Storefront API is a modern REST API based on the [JSON API spec](https://jsonapi.org/) which provides you with all the necessary endpoints to build amazing user interfaces either in JavaScript frameworks or native mobile libraries. Import to [Postman](https://raw.githubusercontent.com/spree/spree/main/docs/api-reference/storefront.yaml) contact: name: Vendo Connect Inc. url: https://spreecommerce.org email: hello@spreecommerce.org license: name: BSD-3-Clause url: https://github.com/spree/spree/blob/main/LICENSE.md servers: - url: https://demo.spreecommerce.org description: demo - url: http://localhost:3000 description: localhost security: [] tags: - name: Account - name: Account / Address - name: Account / Credit Cards - name: Account / Orders - name: Cart - name: Cart / Line Items - name: Cart / Coupons - name: Cart / Other - name: Checkout - name: Checkout / State - name: Checkout / Shipments - name: Checkout / Payments - name: Checkout / Store Credit - name: Stripe - name: Adyen - name: Countries - name: Digital Downloads - name: Order Status - name: Products - name: Variants - name: Stores - name: Policies - name: Taxons - name: Vendors - name: Wishlists - name: Wishlists / Wished Items paths: /api/v2/storefront/taxons: get: tags: - Taxons summary: List all Taxons description: >- Returns a list of Taxons. [Read more about Taxons](/developer/core-concepts/products#taxons-and-taxonomies) operationId: taxons-list parameters: - $ref: '#/components/parameters/FilterByIds' - $ref: '#/components/parameters/FilterByName' - in: query name: filter[parent_id] schema: type: string example: '1' description: Fetch children nodes of specified Taxon - in: query name: filter[parent_permalink] schema: type: string example: clothes description: Fetch children nodes of specified Taxon permalink - in: query name: filter[taxonomy_id] schema: type: string example: '1' description: Fetch Taxons in a specified Taxonomy - in: query name: filter[roots] schema: type: boolean example: false description: Fetch only root Taxons (Taxonomies) - in: query name: filter[vendor_id] schema: type: string example: '1' description: Fetch only Taxons that have products of a selected Vendor - $ref: '#/components/parameters/PageParam' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/TaxonIncludeParam' - $ref: '#/components/parameters/SparseFieldsTaxon' responses: '200': $ref: '#/components/responses/TaxonList' components: parameters: FilterByIds: in: query name: filter[ids] schema: type: string example: 1,2,3 description: Fetch only resources with corresponding IDs FilterByName: in: query name: filter[name] schema: type: string example: rails description: >- Find resources with matching name (supports wild-card, partial-word match search) PageParam: name: page in: query description: Number of requested page when paginating collection schema: type: integer example: 1 PerPageParam: name: per_page in: query description: Number of requested records per page when paginating collection schema: type: integer example: 25 TaxonIncludeParam: name: include in: query schema: type: string description: >- Specify the related resources you would like to receive in the response body. [More Information](https://jsonapi.org/format/#fetching-includes). example: parent,taxonomy,children,image,products SparseFieldsTaxon: in: query name: fields[taxon] example: name,pretty_name,permalink description: >- Specify the fields you would like returned in the response body. [More information](https://jsonapi.org/format/#fetching-sparse-fieldsets). schema: type: string responses: TaxonList: description: 200 Success - Returns an array of `taxon` objects. content: application/vnd.api+json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/Taxon' included: type: array items: $ref: '#/components/schemas/TaxonIncludes' meta: $ref: '#/components/schemas/ListMeta' links: $ref: '#/components/schemas/ListLinks' required: - data - meta - links examples: Standard Response: value: data: - id: '22' type: taxon attributes: name: Summer Sale pretty_name: Categories -> Summer Sale permalink: categories/summer-sale seo_title: Summer Sale description: null meta_title: null meta_description: null meta_keywords: null left: 42 right: 43 position: 0 depth: 1 updated_at: '2021-10-02T11:03:15.118Z' is_root: false is_child: true is_leaf: true relationships: parent: data: id: '1' type: taxon taxonomy: data: id: '1' type: taxonomy children: data: [] image: data: null - id: '17' type: taxon attributes: name: Pants pretty_name: Categories -> Sportswear -> Pants permalink: categories/sportswear/pants seo_title: Pants description: null meta_title: null meta_description: null meta_keywords: null left: 31 right: 32 position: 0 depth: 2 updated_at: '2021-10-02T11:03:15.146Z' is_root: false is_child: true is_leaf: true relationships: parent: data: id: '4' type: taxon taxonomy: data: id: '1' type: taxonomy children: data: [] image: data: null - id: '19' type: taxon attributes: name: Bestsellers pretty_name: Categories -> Bestsellers permalink: categories/bestsellers seo_title: Bestsellers description: null meta_title: null meta_description: null meta_keywords: null left: 36 right: 37 position: 0 depth: 1 updated_at: '2021-10-02T11:03:15.082Z' is_root: false is_child: true is_leaf: true relationships: parent: data: id: '1' type: taxon taxonomy: data: id: '1' type: taxonomy children: data: [] image: data: null - id: '16' type: taxon attributes: name: Sweatshirts pretty_name: Categories -> Sportswear -> Sweatshirts permalink: categories/sportswear/sweatshirts seo_title: Sweatshirts description: null meta_title: null meta_description: null meta_keywords: null left: 29 right: 30 position: 0 depth: 2 updated_at: '2021-10-02T11:03:15.054Z' is_root: false is_child: true is_leaf: true relationships: parent: data: id: '4' type: taxon taxonomy: data: id: '1' type: taxonomy children: data: [] image: data: null - id: '6' type: taxon attributes: name: T-shirts pretty_name: Categories -> Men -> T-shirts permalink: categories/men/t-shirts seo_title: T-shirts description: null meta_title: null meta_description: null meta_keywords: null left: 5 right: 6 position: 0 depth: 2 updated_at: '2021-10-02T11:03:12.242Z' is_root: false is_child: true is_leaf: true relationships: parent: data: id: '2' type: taxon taxonomy: data: id: '1' type: taxonomy children: data: [] image: data: null - id: '4' type: taxon attributes: name: Sportswear pretty_name: Categories -> Sportswear permalink: categories/sportswear seo_title: Sportswear description: null meta_title: null meta_description: null meta_keywords: null left: 26 right: 33 position: 0 depth: 1 updated_at: '2021-10-02T11:03:15.146Z' is_root: false is_child: true is_leaf: false relationships: parent: data: id: '1' type: taxon taxonomy: data: id: '1' type: taxonomy children: data: - id: '15' type: taxon - id: '16' type: taxon - id: '17' type: taxon image: data: null - id: '9' type: taxon attributes: name: Skirts pretty_name: Categories -> Women -> Skirts permalink: categories/women/skirts seo_title: Skirts description: null meta_title: null meta_description: null meta_keywords: null left: 13 right: 14 position: 0 depth: 2 updated_at: '2021-10-02T11:03:13.076Z' is_root: false is_child: true is_leaf: true relationships: parent: data: id: '3' type: taxon taxonomy: data: id: '1' type: taxonomy children: data: [] image: data: null - id: '12' type: taxon attributes: name: Sweaters pretty_name: Categories -> Women -> Sweaters permalink: categories/women/sweaters seo_title: Sweaters description: null meta_title: null meta_description: null meta_keywords: null left: 19 right: 20 position: 0 depth: 2 updated_at: '2021-10-02T11:03:14.071Z' is_root: false is_child: true is_leaf: true relationships: parent: data: id: '3' type: taxon taxonomy: data: id: '1' type: taxonomy children: data: [] image: data: null - id: '15' type: taxon attributes: name: Tops pretty_name: Categories -> Sportswear -> Tops permalink: categories/sportswear/tops seo_title: Tops description: null meta_title: null meta_description: null meta_keywords: null left: 27 right: 28 position: 0 depth: 2 updated_at: '2021-10-02T11:03:14.916Z' is_root: false is_child: true is_leaf: true relationships: parent: data: id: '4' type: taxon taxonomy: data: id: '1' type: taxonomy children: data: [] image: data: null - id: '5' type: taxon attributes: name: Shirts pretty_name: Categories -> Men -> Shirts permalink: categories/men/shirts seo_title: Shirts description: null meta_title: null meta_description: null meta_keywords: null left: 3 right: 4 position: 0 depth: 2 updated_at: '2021-10-02T11:03:11.998Z' is_root: false is_child: true is_leaf: true relationships: parent: data: id: '2' type: taxon taxonomy: data: id: '1' type: taxonomy children: data: [] image: data: null - id: '20' type: taxon attributes: name: Trending pretty_name: Categories -> Trending permalink: categories/trending seo_title: Trending description: null meta_title: null meta_description: null meta_keywords: null left: 38 right: 39 position: 0 depth: 1 updated_at: '2021-10-02T11:03:15.054Z' is_root: false is_child: true is_leaf: true relationships: parent: data: id: '1' type: taxon taxonomy: data: id: '1' type: taxonomy children: data: [] image: data: null - id: '18' type: taxon attributes: name: New pretty_name: Categories -> New permalink: categories/new seo_title: New description: null meta_title: null meta_description: null meta_keywords: null left: 34 right: 35 position: 0 depth: 1 updated_at: '2021-10-02T11:03:15.082Z' is_root: false is_child: true is_leaf: true relationships: parent: data: id: '1' type: taxon taxonomy: data: id: '1' type: taxonomy children: data: [] image: data: null - id: '2' type: taxon attributes: name: Men pretty_name: Categories -> Men permalink: categories/men seo_title: Men description: null meta_title: null meta_description: null meta_keywords: null left: 2 right: 11 position: 0 depth: 1 updated_at: '2021-10-02T11:03:12.728Z' is_root: false is_child: true is_leaf: false relationships: parent: data: id: '1' type: taxon taxonomy: data: id: '1' type: taxonomy children: data: - id: '5' type: taxon - id: '6' type: taxon - id: '7' type: taxon - id: '8' type: taxon image: data: null - id: '8' type: taxon attributes: name: Jackets and Coats pretty_name: Categories -> Men -> Jackets and Coats permalink: categories/men/jackets-and-coats seo_title: Jackets and Coats description: null meta_title: null meta_description: null meta_keywords: null left: 9 right: 10 position: 0 depth: 2 updated_at: '2021-10-02T11:03:12.728Z' is_root: false is_child: true is_leaf: true relationships: parent: data: id: '2' type: taxon taxonomy: data: id: '1' type: taxonomy children: data: [] image: data: null - id: '7' type: taxon attributes: name: Sweaters pretty_name: Categories -> Men -> Sweaters permalink: categories/men/sweaters seo_title: Sweaters description: null meta_title: null meta_description: null meta_keywords: null left: 7 right: 8 position: 0 depth: 2 updated_at: '2021-10-02T11:03:12.486Z' is_root: false is_child: true is_leaf: true relationships: parent: data: id: '2' type: taxon taxonomy: data: id: '1' type: taxonomy children: data: [] image: data: null - id: '11' type: taxon attributes: name: Shirts and Blouses pretty_name: Categories -> Women -> Shirts and Blouses permalink: categories/women/shirts-and-blouses seo_title: Shirts and Blouses description: null meta_title: null meta_description: null meta_keywords: null left: 17 right: 18 position: 0 depth: 2 updated_at: '2021-10-02T11:03:13.767Z' is_root: false is_child: true is_leaf: true relationships: parent: data: id: '3' type: taxon taxonomy: data: id: '1' type: taxonomy children: data: [] image: data: null - id: '13' type: taxon attributes: name: Tops and T-shirts pretty_name: Categories -> Women -> Tops and T-shirts permalink: categories/women/tops-and-t-shirts seo_title: Tops and T-shirts description: null meta_title: null meta_description: null meta_keywords: null left: 21 right: 22 position: 0 depth: 2 updated_at: '2021-10-02T11:03:14.340Z' is_root: false is_child: true is_leaf: true relationships: parent: data: id: '3' type: taxon taxonomy: data: id: '1' type: taxonomy children: data: [] image: data: null - id: '10' type: taxon attributes: name: Dresses pretty_name: Categories -> Women -> Dresses permalink: categories/women/dresses seo_title: Dresses description: null meta_title: null meta_description: null meta_keywords: null left: 15 right: 16 position: 0 depth: 2 updated_at: '2021-10-02T11:03:13.434Z' is_root: false is_child: true is_leaf: true relationships: parent: data: id: '3' type: taxon taxonomy: data: id: '1' type: taxonomy children: data: [] image: data: null - id: '14' type: taxon attributes: name: Jackets and Coats pretty_name: Categories -> Women -> Jackets and Coats permalink: categories/women/jackets-and-coats seo_title: Jackets and Coats description: null meta_title: null meta_description: null meta_keywords: null left: 23 right: 24 position: 0 depth: 2 updated_at: '2021-10-02T11:03:14.688Z' is_root: false is_child: true is_leaf: true relationships: parent: data: id: '3' type: taxon taxonomy: data: id: '1' type: taxonomy children: data: [] image: data: null - id: '23' type: taxon attributes: name: New Collection pretty_name: Categories -> New Collection permalink: categories/new-collection seo_title: New Collection description: null meta_title: null meta_description: null meta_keywords: null left: 44 right: 47 position: 0 depth: 1 updated_at: '2021-10-02T11:03:15.001Z' is_root: false is_child: true is_leaf: false relationships: parent: data: id: '1' type: taxon taxonomy: data: id: '1' type: taxonomy children: data: - id: '24' type: taxon image: data: null - id: '24' type: taxon attributes: name: Summer 2021 pretty_name: Categories -> New Collection -> Summer 2021 permalink: categories/new-collection/summer-2021 seo_title: Summer 2021 description: null meta_title: null meta_description: null meta_keywords: null left: 45 right: 46 position: 0 depth: 2 updated_at: '2021-10-02T11:03:15.001Z' is_root: false is_child: true is_leaf: true relationships: parent: data: id: '23' type: taxon taxonomy: data: id: '1' type: taxonomy children: data: [] image: data: null - id: '26' type: taxon attributes: name: 30% Off pretty_name: Categories -> Special Offers -> 30% Off permalink: categories/special-offers/30-percent-off seo_title: 30% Off description: null meta_title: null meta_description: null meta_keywords: null left: 49 right: 50 position: 0 depth: 2 updated_at: '2021-10-02T11:03:15.118Z' is_root: false is_child: true is_leaf: true relationships: parent: data: id: '25' type: taxon taxonomy: data: id: '1' type: taxonomy children: data: [] image: data: null - id: '25' type: taxon attributes: name: Special Offers pretty_name: Categories -> Special Offers permalink: categories/special-offers seo_title: Special Offers description: null meta_title: null meta_description: null meta_keywords: null left: 48 right: 51 position: 0 depth: 1 updated_at: '2021-10-02T11:03:15.118Z' is_root: false is_child: true is_leaf: false relationships: parent: data: id: '1' type: taxon taxonomy: data: id: '1' type: taxonomy children: data: - id: '26' type: taxon image: data: null - id: '21' type: taxon attributes: name: Streetstyle pretty_name: Categories -> Streetstyle permalink: categories/streetstyle seo_title: Streetstyle description: null meta_title: null meta_description: null meta_keywords: null left: 40 right: 41 position: 0 depth: 1 updated_at: '2021-10-02T11:03:15.146Z' is_root: false is_child: true is_leaf: true relationships: parent: data: id: '1' type: taxon taxonomy: data: id: '1' type: taxonomy children: data: [] image: data: null - id: '1' type: taxon attributes: name: Categories pretty_name: Categories permalink: categories seo_title: Categories description: null meta_title: null meta_description: null meta_keywords: null left: 1 right: 52 position: 0 depth: 0 updated_at: '2021-10-02T11:03:15.146Z' is_root: true is_child: false is_leaf: false relationships: parent: data: null taxonomy: data: id: '1' type: taxonomy children: data: - id: '2' type: taxon - id: '3' type: taxon - id: '4' type: taxon - id: '18' type: taxon - id: '19' type: taxon - id: '20' type: taxon - id: '21' type: taxon - id: '22' type: taxon - id: '23' type: taxon - id: '25' type: taxon image: data: null meta: count: 25 total_count: 26 total_pages: 2 links: self: http://localhost:3000/api/v2/storefront/taxons next: http://localhost:3000/api/v2/storefront/taxons?page=2 prev: http://localhost:3000/api/v2/storefront/taxons?page=1 last: http://localhost:3000/api/v2/storefront/taxons?page=2 first: http://localhost:3000/api/v2/storefront/taxons?page=1 schemas: Taxon: title: Taxon type: object x-internal: false properties: id: type: string example: '1' type: type: string default: taxon attributes: type: object properties: name: type: string example: T-shirts pretty_name: type: string example: Clothes > T-shirts permalink: type: string example: t-shirts seo_title: type: string example: Clothes - T-shirts meta_title: type: string example: T-shirts nullable: true meta_description: type: string example: 'A list of cool t-shirts ' nullable: true meta_keywords: type: string example: t-shirts, cool nullable: true left: type: integer example: 1 right: type: integer example: 2 position: type: integer example: 0 depth: type: integer example: 1 nullable: true is_root: type: boolean example: true description: Indicates if the Taxon is the root node of this Taxonomy tree is_child: type: boolean example: true description: Returns true is this is a child node of this Taxonomy tree is_leaf: type: boolean example: false description: >- Returns true if this is the end of a branch of this Taxonomy tree updated_at: type: string example: '2018-06-18T10:57:29.704Z' localized_slugs: type: object description: Provides taxon's slugs in other locales relationships: type: object properties: parent: type: object description: Parent node properties: data: $ref: '#/components/schemas/Relation' children: type: object description: List of child nodes properties: data: type: array items: $ref: '#/components/schemas/Relation' taxonomy: type: object description: Taxonomy associated with this Taxon properties: data: $ref: '#/components/schemas/Relation' image: type: object description: Image associated with Taxon properties: data: $ref: '#/components/schemas/Relation' products: type: object description: List of active and available Products associated with this Taxon properties: data: type: array items: $ref: '#/components/schemas/Relation' required: - id - type - attributes - relationships TaxonIncludes: x-internal: false title: Taxon Includes anyOf: - $ref: '#/components/schemas/Product' - $ref: '#/components/schemas/TaxonImage' - $ref: '#/components/schemas/Taxonomy' ListMeta: type: object x-internal: false title: Pagination Meta properties: count: type: number example: 7 description: Number of items on the current listing total_count: type: number example: 145 description: Number of all items matching the criteria total_pages: type: number example: 10 description: Number of all pages containing items matching the criteria ListLinks: x-internal: false type: object title: Pagination Links properties: self: type: string description: URL to the current page of the listing next: type: string description: URL to the next page of the listing prev: type: string description: URL to the previous page of the listing last: type: string description: URL to the last page of the listing first: type: string description: URL to the first page of the listing Relation: type: object nullable: true properties: id: type: string type: type: string required: - id - type x-internal: false description: '' Product: type: object title: Product x-internal: false properties: id: type: string example: '1' type: type: string default: product attributes: type: object properties: name: type: string example: Example product description: type: string example: Example description nullable: true available_on: type: string example: '2012-10-17T03:43:57Z' nullable: true slug: type: string example: example-product price: type: string example: '15.99' nullable: true currency: type: string example: USD display_price: type: string example: $15.99 nullable: true purchasable: type: boolean description: Indicates if any of Variants are in stock or backorderable in_stock: type: boolean description: Indicates if any of Variants are in stock backorderable: type: boolean description: Indicates if any of Variants are backeorderable meta_description: type: string example: Example product nullable: true meta_keywords: type: string example: example, product nullable: true updated_at: $ref: '#/components/schemas/Timestamp' sku: type: string example: 9238-WS available: type: boolean compare_at_price: type: string example: '49.99' nullable: true display_compare_at_price: type: string example: $49.99 nullable: true localized_slugs: type: object description: Provides product's slugs in other locales tags: type: array items: type: string description: List of tags associated with the product labels: type: array items: type: string description: List of labels associated with the product relationships: type: object properties: variants: type: object description: List of Product Variants, excluding Master Variant properties: data: type: array items: $ref: '#/components/schemas/Relation' option_types: type: object description: List of Product Option Types properties: data: type: array items: $ref: '#/components/schemas/Relation' product_properties: type: object description: List of Product Properties properties: data: type: array items: $ref: '#/components/schemas/Relation' taxons: type: object description: List of Taxons associated with this Product properties: data: type: array items: $ref: '#/components/schemas/Relation' images: type: object description: List of Images associated with this Product properties: data: type: array items: $ref: '#/components/schemas/Relation' default_variant: type: object description: The default Variant for this product properties: data: $ref: '#/components/schemas/Relation' primary_variant: type: object description: The Primary Variant for this product properties: data: $ref: '#/components/schemas/Relation' required: - id - type - attributes - relationships TaxonImage: type: object properties: id: type: string example: '1' type: type: string default: taxon_image attributes: type: object properties: position: type: integer example: 0 description: Sort order of images set in the Admin Panel styles: type: array description: An array of pre-scaled image styles items: $ref: '#/components/schemas/ImageStyle' required: - id - type - attributes title: Taxon Image x-internal: false Taxonomy: type: object title: Taxonomy x-internal: false properties: id: type: string example: '1' type: type: string default: taxonomy attributes: type: object properties: name: type: string example: Categories position: type: integer example: 0 required: - id - type - attributes Timestamp: type: string format: date-time example: '2020-02-16T07:14:54.617Z' x-internal: false title: Time Stamp x-examples: example-1: '2020-02-16T07:14:54.617Z' ImageStyle: x-internal: false title: Image Style type: object properties: url: type: string example: >- http://localhost:3000/rails/active_storage/disk/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJbWQyWVhKcFlXNTBjeTltWm1sMmRURlNORFpZWjJaSFpYUkdZMjk2WWsxM1RHWXZNVGs1T1RCak5XVmlNamN4TlRnd1pqVTBabUpqTWpCbFkyVXhZMlZpTTJFd05ERTJZemMzT0dKaE5tSTFNREkyT0dKaFpqa3paV1JtWTJWaE16aGxaQVk2QmtWVSIsImV4cCI6IjIwMTgtMDYtMjRUMTM6NTk6NTguOTY5WiIsInB1ciI6ImJsb2Jfa2V5In19--5e9ff358dc747f73754e332678c5762114ac6f3f/ror_jr_spaghetti.jpeg?content_type=image%2Fjpeg&disposition=inline%3B+filename%3D%22ror_jr_spaghetti.jpeg%22%3B+filename%2A%3DUTF-8%27%27ror_jr_spaghetti.jpeg description: Absolute URL of the uploaded image in selected style (width/height) width: type: integer example: 1920 description: Actual width of image height: type: integer example: 1080 description: Actual height of image ````