GET
/
api
/
v2
/
platform
/
taxons
curl --request GET \
  --url http://{defaultHost}/api/v2/platform/taxons \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "38",
      "type": "taxon",
      "attributes": {
        "position": 0,
        "name": "Shorts",
        "permalink": "taxonomy-25/shorts",
        "lft": 2,
        "rgt": 3,
        "description": null,
        "created_at": "2022-11-08T19:35:49.576Z",
        "updated_at": "2022-11-08T19:35:49.581Z",
        "meta_title": null,
        "meta_description": null,
        "meta_keywords": null,
        "depth": 1,
        "public_metadata": {},
        "private_metadata": {},
        "pretty_name": "taxonomy_25 -> Shorts",
        "seo_title": "Shorts",
        "is_root": false,
        "is_child": true,
        "is_leaf": true
      },
      "relationships": {
        "parent": {
          "data": {
            "id": "37",
            "type": "taxon"
          }
        },
        "taxonomy": {
          "data": {
            "id": "25",
            "type": "taxonomy"
          }
        },
        "children": {
          "data": []
        },
        "image": {
          "data": {
            "id": "89",
            "type": "taxon_image"
          }
        }
      }
    },
    {
      "id": "39",
      "type": "taxon",
      "attributes": {
        "position": 0,
        "name": "taxon_13",
        "permalink": "taxonomy-25/taxon-13",
        "lft": 4,
        "rgt": 5,
        "description": null,
        "created_at": "2022-11-08T19:35:49.603Z",
        "updated_at": "2022-11-08T19:35:49.606Z",
        "meta_title": null,
        "meta_description": null,
        "meta_keywords": null,
        "depth": 1,
        "public_metadata": {},
        "private_metadata": {},
        "pretty_name": "taxonomy_25 -> taxon_13",
        "seo_title": "taxon_13",
        "is_root": false,
        "is_child": true,
        "is_leaf": true
      },
      "relationships": {
        "parent": {
          "data": {
            "id": "37",
            "type": "taxon"
          }
        },
        "taxonomy": {
          "data": {
            "id": "25",
            "type": "taxonomy"
          }
        },
        "children": {
          "data": []
        },
        "image": {
          "data": {
            "id": "90",
            "type": "taxon_image"
          }
        }
      }
    },
    {
      "id": "40",
      "type": "taxon",
      "attributes": {
        "position": 0,
        "name": "taxon_14",
        "permalink": "taxonomy-25/taxon-14",
        "lft": 6,
        "rgt": 7,
        "description": null,
        "created_at": "2022-11-08T19:35:49.625Z",
        "updated_at": "2022-11-08T19:35:49.628Z",
        "meta_title": null,
        "meta_description": null,
        "meta_keywords": null,
        "depth": 1,
        "public_metadata": {},
        "private_metadata": {},
        "pretty_name": "taxonomy_25 -> taxon_14",
        "seo_title": "taxon_14",
        "is_root": false,
        "is_child": true,
        "is_leaf": true
      },
      "relationships": {
        "parent": {
          "data": {
            "id": "37",
            "type": "taxon"
          }
        },
        "taxonomy": {
          "data": {
            "id": "25",
            "type": "taxonomy"
          }
        },
        "children": {
          "data": []
        },
        "image": {
          "data": {
            "id": "91",
            "type": "taxon_image"
          }
        }
      }
    },
    {
      "id": "37",
      "type": "taxon",
      "attributes": {
        "position": 0,
        "name": "taxonomy_25",
        "permalink": "taxonomy-25",
        "lft": 1,
        "rgt": 8,
        "description": null,
        "created_at": "2022-11-08T19:35:49.552Z",
        "updated_at": "2022-11-08T19:35:49.636Z",
        "meta_title": null,
        "meta_description": null,
        "meta_keywords": null,
        "depth": 0,
        "public_metadata": {},
        "private_metadata": {},
        "pretty_name": "taxonomy_25",
        "seo_title": "taxonomy_25",
        "is_root": true,
        "is_child": false,
        "is_leaf": false
      },
      "relationships": {
        "parent": {
          "data": null
        },
        "taxonomy": {
          "data": {
            "id": "25",
            "type": "taxonomy"
          }
        },
        "children": {
          "data": [
            {
              "id": "38",
              "type": "taxon"
            },
            {
              "id": "39",
              "type": "taxon"
            },
            {
              "id": "40",
              "type": "taxon"
            }
          ]
        },
        "image": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "count": 4,
    "total_count": 4,
    "total_pages": 1
  },
  "links": {
    "self": "http://www.example.com/api/v2/platform/taxons?page=1&per_page=&include=&filter[taxonomy_id_eq]=&filter[name_cont]=",
    "next": "http://www.example.com/api/v2/platform/taxons?filter%5Bname_cont%5D=&filter%5Btaxonomy_id_eq%5D=&include=&page=1&per_page=",
    "prev": "http://www.example.com/api/v2/platform/taxons?filter%5Bname_cont%5D=&filter%5Btaxonomy_id_eq%5D=&include=&page=1&per_page=",
    "last": "http://www.example.com/api/v2/platform/taxons?filter%5Bname_cont%5D=&filter%5Btaxonomy_id_eq%5D=&include=&page=1&per_page=",
    "first": "http://www.example.com/api/v2/platform/taxons?filter%5Bname_cont%5D=&filter%5Btaxonomy_id_eq%5D=&include=&page=1&per_page="
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer
​
per_page
integer
​
include
string

Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>

​
filter[taxonomy_id_eq]
string
​
filter[name_cont]
string

Response

200
application/vnd.api+json
Records returned
​
data
object[]
required
​
meta
object
required
​
links
object
required

Was this page helpful?

Suggest editsRaise issue
Update a TaxonomyCreate a Taxon