List Categories
GET {{baseUrl}}/categories?page=<integer>&keyword=<string>&status=<string>
This endpoint allows you to list all categories related to your store directly from this endpoint. Also, it allows you to filter them using a keyword, the endpoint would return any category which name matches this keyword.
categories.read- Categories Read Only
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
page | string | The Pagination page number | |
keyword | string | A keyword to filter categories by a specific name. | |
status | string | The status of the category, whether or not it is active or hidden |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"status":"\u003cnumber\u003e","success":"\u003cboolean\u003e","data":[{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e","urls":{"customer":"\u003cstring\u003e","admin":"\u003cstring\u003e"},"items":[{"value":"\u003cCircular reference to #/components/schemas/Category detected\u003e"},{"value":"\u003cCircular reference to #/components/schemas/Category detected\u003e"}],"parent_id":"\u003cinteger\u003e","sort_order":"\u003cinteger\u003e","status":"active","metadata_title":"\u003cstring\u003e","metadata_description ":"\u003cstring\u003e","metadata_url":"\u003cstring\u003e"},{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e","urls":{"customer":"\u003cstring\u003e","admin":"\u003cstring\u003e"},"items":[{"value":"\u003cCircular reference to #/components/schemas/Category detected\u003e"},{"value":"\u003cCircular reference to #/components/schemas/Category detected\u003e"}],"parent_id":"\u003cinteger\u003e","sort_order":"\u003cinteger\u003e","status":"hidden","metadata_title":"\u003cstring\u003e","metadata_description ":"\u003cstring\u003e","metadata_url":"\u003cstring\u003e"}],"pagination":{"count":"\u003cnumber\u003e","total":"\u003cnumber\u003e","perPage":"\u003cnumber\u003e","currentPage":"\u003cnumber\u003e","totalPages":"\u003cnumber\u003e","links":["\u003cstring\u003e","\u003cstring\u003e"]}}