Skip to content
Optiwork API Docs

Search tags

GET
/tags/search
curl --request GET \
  --url 'https://feed.work.optidata.cloud/api/tags/search?query=hr' \
  --header 'Authorization: Bearer <token>'

Tags whose name contains the query, with a ready-made badge class for the UI.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
query
required
string

Text the tag name must contain.

Responses

Section titled “ Responses ”

200

Section titled “200”

Matching tags.

Media typeapplication/json
object
tags
required
Array<object>
object
id
required
integer
name
required
string
color
required
string
Allowed values: primary secondary success danger warning info dark
data
object
badgeClass
string
Examples
Exampleexample
{
  "tags": [
    {
      "id": 89,
      "color": "success",
      "name": "hr",
      "data": {
        "badgeClass": "badge-light-success"
      }
    }
  ]
}

401

Section titled “401”

No authentication key was sent.

Media typeapplication/json

Authentication failures use an error key.

object
error
required
string
Examples
Exampleexample
{
  "error": "JWT passport exception: Missing bearer token in request"
}

419

Section titled “419”

The authentication key is expired or not recognised. Get a fresh one and retry.

Media typeapplication/json

Authentication failures use an error key.

object
error
required
string
Examples
Exampleexample
{
  "error": "JWT passport expired: Passport expired"
}

422

Section titled “422”

The request failed validation.

Media typeapplication/json
object
message
required

The first validation message.

string
errors
required

Messages keyed by field name.

object
key
additional properties
Array<string>
Examples
Exampleexample
{
  "message": "The name field is required.",
  "errors": {
    "name": [
      "The name field is required."
    ]
  }
}