Sign in

v1

latestOpenAPI 3.0.32026-07-13149852.3 MB
tag

Tag - Get

Retrieve all tags with optional filtering by type.

get/tag/get

Query parameters

selectorobject required

Query selector object for filtering results

limitnumber

Max results to return

Example:50
skipnumber

Number of results to skip

sortobject

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

Response

Array of tags matching the query

_idstring required

Unique tag identifier

namestring required

Tag name

type'orders' | 'items' | 'purchase_order' | 'customers' required

Tag type

color'red' | 'orange' | 'yellow' | 'green' | 'blue' | 'purple' | 'indigo' | 'gray' | 'maroon' | 'fuchsia' | 'chartreuse' | 'dodger' | 'salmon' | 'cornflower' | 'khaki' | 'steel' | 'plum' required

Tag color

Example response

[
  {
    "_id": "507f1f77bcf86cd799439011"
  }
]