Skip to main content
GET
/
api
/
v2
/
platform
/
classifications
Return a list of Classifications
curl --request GET \
  --url http://{defaultHost}/api/v2/platform/classifications \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "1",
      "type": "classification",
      "attributes": {
        "position": 1,
        "created_at": "2022-11-08T19:33:57.238Z",
        "updated_at": "2022-11-08T19:33:57.238Z"
      },
      "relationships": {
        "product": {
          "data": {
            "id": "9",
            "type": "product"
          }
        },
        "taxon": {
          "data": {
            "id": "2",
            "type": "taxon"
          }
        }
      }
    },
    {
      "id": "2",
      "type": "classification",
      "attributes": {
        "position": 1,
        "created_at": "2022-11-08T19:33:57.322Z",
        "updated_at": "2022-11-08T19:33:57.322Z"
      },
      "relationships": {
        "product": {
          "data": {
            "id": "10",
            "type": "product"
          }
        },
        "taxon": {
          "data": {
            "id": "4",
            "type": "taxon"
          }
        }
      }
    }
  ],
  "meta": {
    "count": 2,
    "total_count": 2,
    "total_pages": 1
  },
  "links": {
    "self": "http://www.example.com/api/v2/platform/classifications?page=1&per_page=&include=&filter[taxon_id_eq]=",
    "next": "http://www.example.com/api/v2/platform/classifications?filter%5Btaxon_id_eq%5D=&include=&page=1&per_page=",
    "prev": "http://www.example.com/api/v2/platform/classifications?filter%5Btaxon_id_eq%5D=&include=&page=1&per_page=",
    "last": "http://www.example.com/api/v2/platform/classifications?filter%5Btaxon_id_eq%5D=&include=&page=1&per_page=",
    "first": "http://www.example.com/api/v2/platform/classifications?filter%5Btaxon_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: https://jsonapi.org/format/#fetching-includes

​
filter[taxon_id_eq]
string

Response

Records returned

​
data
object[]
required
​
meta
object
required
​
links
object
required