Get a list of tags

GET 
/api/tags

Get a list of tags

Request

Query Parameters

type string

type of the tag

order_by object

order by clause

per_page integer

number of items per page

page integer

page number that you want (see meta for pagination infos)

Responses

200

Successful response

application/json

Schema

Schema

data object[]required
Array [
id int64
Unique identifier of the tag
name object
Name of the tag
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
icon object
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
slug object
Short human readable identifier (no accentuation + whitespaces replaced by hyphens)
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
ref_id string
Reference id of the tag (used by the provider that created the tag). null if it's created internally
ref_type string
Reference type of the tag (used by the provider that created the tag). null if it's created internally
type stringrequired
Type of the tag (e.g. labels, uom, Allergen, etc..)
order_column string
Order by sequence within the tag type
active boolean
Active status of the tag (true or false)
created_at string
Date of creation of the tag
updated_at string
Date of last update of the tag
]
current_page integer
first_page_url string
from integer
last_page integer
last_page_url string
links object[]
Array [
url string
label string
active boolean
]
next_page_url string
path string
per_page integer
prev_page_url string
to integer
total integer

Example (from schema)

{
  "data": [
    {
      "id": 0,
      "name": {
        "fr": "string",
        "nl": "string",
        "en": "string",
        "de": "string"
      },
      "icon": {
        "fr": "string",
        "nl": "string",
        "en": "string",
        "de": "string"
      },
      "slug": {
        "fr": "string",
        "nl": "string",
        "en": "string",
        "de": "string"
      },
      "ref_id": "string",
      "ref_type": "string",
      "type": "string",
      "order_column": "string",
      "active": true,
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "current_page": 0,
  "first_page_url": "string",
  "from": 0,
  "last_page": 0,
  "last_page_url": "string",
  "links": [
    {
      "url": "string",
      "label": "string",
      "active": true
    }
  ],
  "next_page_url": "string",
  "path": "string",
  "per_page": 0,
  "prev_page_url": "string",
  "to": 0,
  "total": 0
}

Loading...