Skip to main content
Tags
Wade Williams avatar
Written by Wade Williams
Updated over 5 years ago

Overview

The tags API allows you to view tag information for a specific product.

/api/products/{product_id}/tags.json

GET

Fetch all of the tags for the given product.

Example Response

  
  [{  "id": 1,
  "tag": "tag1",
  "item_last_modified_time": "2014-07-14T18:02:47+00:00",
  "assignees": [1, 2, 3],
  "type_story": 2,
  "type_task": 1,
  "type_defect": 1,
  "type_test": 1,
  "status_someday": 2,
  "status_current": 1,
  "status_backlog": 1,
  "status_complete": 1,
  "status_accepted": 1
  }, {
  "id": 2,
  "tag": "tag2",
  "item_last_modified_time": "2014-07-12T17:03:46+00:00",
  "assignees": [1],
  "type_story": 1,
  "type_task": 1,
  "type_defect": 2,
  "type_test": 1,
  "status_someday": 1,
  "status_current": 1,
  "status_backlog": 2,
  "status_complete": 1,
  "status_accepted": 1
  }, {
  "id": 3,
  "tag": "tag3",
  "item_last_modified_time": "2014-07-11T10:03:22+00:00",
  "assignees": [2],
  "type_story": 1,
  "type_task": 2,
  "type_defect": 1,
  "type_test": 1,
  "status_someday": 1,
  "status_current": 1,
  "status_backlog": 1,
  "status_complete": 2,
  "status_accepted": 1
  }]
  

Error codes

  • 403 If the user making the request is not a member of the product_id.

  • 404 if product_id is invalid or unknown.

/api/products/{product_id}/tags/{tag_name}.json

This endpoint will return a specific tag by product by ID and tag name.

GET

Return tag info for a specific tag on a product.

Example Response

 
  {
  "id": 1,
  "tag": "tag1",
  "item_last_modified_time": "2014-07-14T18:02:47+00:00",
  "assignees": [1, 2, 3],
  "type_story": 2,
  "type_task": 1,
  "type_defect": 1,
  "type_test": 1,
  "status_someday": 2,
  "status_current": 1,
  "status_backlog": 1,
  "status_complete": 1,
  "status_accepted": 1
  }
  

Error codes

  • 403 If the user making the request is not a member of the product_id.

  • 404 if product_id is invalid or unknown.

  • 404 if tag_name is invalid or unknown.

Did this answer your question?