Tag - Get

Retrieve all tags with optional filtering by type.

GET /tag/get

Tag - Get

cURL

curl --request GET \
  --url https://api.skulabs.com/tag/get \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "_id": "507f1f77bcf86cd799439011",
    "name": "<string>",
    "type": "orders",
    "color": "red"
  }
]

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

selector · object · required

Query selector object for filtering results

limit · number

Max results to return

Example:

50

skip · number

Number of results to skip

Example:

0

sort · object

Sort fields object, e.g. { "name": 1 }

Response

200

application/json

Array of tags matching the query

_id · string · required

Unique tag identifier

Example:

"507f1f77bcf86cd799439011"

name · string · required

Tag name

type · enum<string> · required

Tag type

Available options: orders, items, purchase_order, customers

color · enum<string> · required

Tag color

Available options: red, orange, yellow, green, blue, purple, indigo, gray, maroon, fuchsia, chartreuse, dodger, salmon, cornflower, khaki, steel, plum