Skip to main content

GET - List of tags

List of tags

Request

  • Method: GET
  • Endpoint: /tags
  • Base URL: https://api.targpatrol.com/api/v1
  • Operation ID: list-of-tags

Authorization

This endpoint requires an external API key.

x-api-key: {your_external_api_key}

Parameters

NameInRequiredSchemaDescription
limitquerynointegerinclude first N items of a resource collection
offsetquerynonumberexclude first N items of a resource collection

Responses

200 OK

Content-Type: application/json Schema: object

Schema
{
"allOf": [
{
"$ref": "#/components/schemas/PageResponse"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
}

Example: example-1

{
"data": [
"hall",
"room 1"
],
"meta": {
"offset": 0,
"limit": 20,
"count": 2,
"sort": [
{
"property": "1",
"direction": "asc"
}
],
"filter": []
}
}

401 Unauthorized

500 Internal Server Error

Content-Type: application/json Schema: ErrorResponse

Schema
{
"$ref": "#/components/schemas/ErrorResponse"
}

Example: example-1

{
"message": "internal server error",
"code": "internal.server.error",
"timestamp": "2023-03-07T05:57:59.315Z"
}