GET /brands

Fetch all brands

Query parameters

search string

Search by resource Name
page integer

requested page number

Minimum value is 1. Default value is 1.
page_size integer

requested page size

Minimum value is 1, maximum value is 100. Default value is 12.

Responses

200

successful operation
Hide response attributes Show response attributes object
- data array[object]
  
  Hide data attributes Show data attributes array[object]
  
  id integer
  
  alias string
  
  title string
  
  created_at string(DateTime)
  
  updated_at string(DateTime)
  
  owner_user_id integer
  
  product_count integer
  
  owner object
  
  Hide owner attributes Show owner attributes object
  
  id integer
  
  username string
  
  user_type string
  
  last_active string
- links object
  
  Hide links attributes Show links attributes object
  
  first string(url)
  
  last string(url)
  
  prev string(url)
  
  next string(url)
400

Bad Request
401

Authorization information is missing or invalid.
500

Server Error

GET /brands

curl \
 -X GET https://api.cosmily.com/api/v1/brands \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "data": [
    {
      "id": 111,
      "alias": "pasjel",
      "title": "PasJel",
      "product_count": 243,
      "created_at": "2021-10-04T13:24:22.000Z",
      "updated_at": "2021-11-13T20:23:18.000Z",
      "owner": {
        "id": 222,
        "username": "pasjel_cosmily",
        "user_type": "brand",
        "last_active": "2022--2-09T21:22:23.000Z"
      }
    }
  ],
  "links": {
    "first": "/api/v1/brands?page=1",
    "last": "/api/v1/brands?page=1"
  }
}

Response examples (200)

{
  "data": [
    {
      "id": 111,
      "alias": "pasjel",
      "owner": {
        "id": 222,
        "username": "pasjel_cosmily",
        "user_type": "brand",
        "last_active": "2022--2-09T21:22:23.000Z"
      },
      "title": "PasJel",
      "created_at": "2021-10-04T13:24:22.000Z",
      "updated_at": "2021-11-13T20:23:18.000Z",
      "product_count": 243
    }
  ],
  "links": {
    "last": "/api/v1/brands?page=1",
    "first": "/api/v1/brands?page=1"
  }
}