API Documentation

API Endpoint

Tags

Tags

Supported filter params

  • person_id (array)

  • company_id (array)

  • deal_id (array)

  • task_id (array)

  • invoice_id (array)

  • project_id (array)

  • taggable_type (budget, deal, task, company, person, invoice)

GET /api/v2/tags
Requestsreturns tags

GET  /api/v2/tags

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "35",
      "type": "tags",
      "attributes": {
        "name": "Tag1",
        "color_id": null
      }
    }
  ],
  "links": {
    "first": "http://api-test.productive.io/api/v2/tags?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://api-test.productive.io/api/v2/tags?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200
  }
}

Get tags
GET/api/v2/tags

GET /api/v2/tags/1
Requestsreturns tag

GET  /api/v2/tags/36

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "36",
    "type": "tags",
    "attributes": {
      "name": "Tag2",
      "color_id": null
    }
  },
  "meta": {}
}

Gets a tag
GET/api/v2/tags/{id}

URI Parameters
HideShow
id
number (required) Example: 1

tag id

Generated by aglio on 02 Aug 2025