API Reference

List categories

get
https://api-sandbox.buyingfreedom.app/api/manufacturers/categories

Gets a list of categories associated with a manufacturer, including details such as category name, description, and hierarchical relationships.

Use this endpoint to filter, sort, and paginate the categories returned.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Specifies the field to sort by. To sort in descending order, add "-" in the beginning. Allowed values:

  • id
  • name
  • code
  • parent.name

Default is id.

string

Filters categories by the provided category name.

string

Filters categories by the provided category code.

string

Filters categories based on the name of their parent category.

integer

Excludes a specific category identified by ID from the results.

boolean

Only returns categories that have no children (leaf nodes).

string

Filter by trashed status. Allowed values:

  • with
  • only
  • without

Default is without.

string

Filter by all.

integer

Page number for pagination. Must be a positive integer.

integer

Sets the number of categories returned per page.

Response

Updated 11 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 months ago

Did this page help you?