Skip to main content

Get a Category by ID

GET 
/api/categories/:id

Get a Category by ID

Request​

Path Parameters

    id integerrequired

Query Parameters

    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​

A Category object

Schema
    id int64
    name 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

    code string

    Code of the category

    level integer

    Level of the category

    description 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

    active boolean

    Active status of the category (true or false)

    slug 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

    type stringrequired

    Type of the category (e.g. product, service, etc..)

    _lft integer

    Left value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)

    _rgt integer

    Right value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)

    parent_id integer

    Parent category id

    created_at string

    Date of creation of the category

    updated_at string

    Date of last update of the category

Loading...