Category

Get product category

HTTP Request

[GET] /api/v6/products/categories

Query Parameters

Fields

Fields	Type	Description
id	integer	Identifier
category_name	string	Category name
category_code	string	Category code
description	string	Description
is_default	bool	Is default
parent_id	integer	Parent category
level	integer	Category level

Filtering

Fields	Support	Type	Description
id	eq,in	integer	Identifier
valid	is,in	integer	Valid or not

Sort

Sort (field)	Direction
id	asc,desc

Limit & Offset

	Type	Description
Limit	integer	Number of records to retrieve
Offset	integer	Number of records to skip

Example

HTTP Request

GET api/v6/products/categories?fields=category_name&limit=1&offset=0&filtering[id]=4 HTTP/1.1
Host: example.getflycrm.com
Content-Type: application/json

Status

200 OK

Response

{
  "data": [
    {
      "id": 4,
      "category_name": "TEST PRODUCT CATEGORY API"
    }
  ],
  "has_more": false,
  "offset": 0,
  "limited": 1
}