List Categories
GET {{baseUrl}}/categories?page=1&keyword=<string>
You can 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.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
page | number | The Pagination page number | |
keyword | string | A keyword to filter categories by a specific name. |
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"}],"parent_id":"\u003cinteger\u003e","status":"hidden","sort_order":"\u003cinteger\u003e"}]}