Sign in
InventoryBrands

List Inventory Brands

This endpoint retrieves a list of all the inventory brands for the given organisation.

get/inventory/brands

Query parameters

site_idstring uuid required

Filter inventory brands by site.

archivedboolean

Whether to include archived resources in the response. When true, archived resources are returned; when false or omitted, only non-archived resources are returned.

querystring

A search query to filter inventory brands by. This will search the brand name.

pageinteger

The page to retrieve results from

per_pageinteger

The number of results to return per page

Response

The inventory brands were successfully retrieved

Example response

{
  "data": [
    {
      "name": "L'Oréal"
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  }
}

Changes