Tag

Private Tag API endpoints

Endpoints

GET/tags

Get list of tags

GET /tags

Get a paginated list of all tags for the shop.

Query parameters

pageoptionalinteger

Page number (>= 1)

Defaults to 1.

per_pageoptionalinteger

Items per page (1..500)

Defaults to 25.

queryoptionalstring | null

Filter tags by name substring (LIKE %query%).

sort[field]optionalstring

Field to sort by. Required whenever any sort[...] key is present, so sending sort[direction] on its own returns 422. Send sort as an object (sort[field]=name), never as a scalar.

Possible values: id, name.

sort[direction]optionalstring

Sort direction; defaults to asc.

Possible values: asc, desc.

Defaults to "asc".

Returnsobject

Tags list response

curl https://api.subbly.co/private/v1/tags \
  -H 'X-API-KEY: <api-key>'

Response

{
  "pagination": {
    "current_page": 1,
    "last_page": 2,
    "from": 1,
    "to": 1,
    "total": 20
  },
  "data": [
    {
      "id": 1,
      "name": "New Arrivals",
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ]
}

Tag