Tags

List tags

Search and list the tags of jobs.

Query Parameters

Name, Type	Description
type Required string	Searches for tags in the specified type. Possible values: `job` Default value: `job`
search Required string	Used for searching tags.

HTTP Response Status Codes

Status code	Description
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

Code samples

GET

/v1/tags

curl -X GET \
  /api/v1/tags \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Service-CRN: YOUR-SERVICE-CRN' \
  -H 'IBM-API-Version: 2025-05-01'

import requests
 
response = requests.request(
    "GET",
    "/api/v1/tags",
    headers={
      "Accept": "application/json",
      "IBM-API-Version": "2025-05-01",
      "Authorization": "Bearer YOUR-TOKEN",
      "Service-CRN": "YOUR-SERVICE-CRN"
    },
)
print(response.json())

Responses

Status code

{
  "tags": [
    "tag1",
    "tag2",
    "tag3",
    "tag4"
  ]
}

Status code

{
  "type": "object",
  "properties": {
    "tags": {
      "title": "Tags",
      "description": "List of job or program tags",
      "type": "array",
      "minItems": 1,
      "maxItems": 5,
      "items": {
        "type": "string",
        "pattern": ".*",
        "minLength": 1,
        "maxLength": 24
      }
    }
  }
}