Project Tags - Polarix.io

Retrieves Project tags list based on the {project_id} path parameter. Project ID is retrieved by calling the "Project List" endpoint.

Each object returned will contain a style key/value pair these equate to a color that Polarix uses for eassy identification, we have listed the string value with it's associated RGB value here so that you can replicate the tags in your interface.

"amber": "rgb(209, 105, 31)"
"amethyst" : "rgb(172, 55, 111)"
"ruby" : "rgb(219, 33, 33)"
"emerald" : "rgb(16, 132, 103)"
"moonstone" : "rgb(235, 235, 235)"

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

version

number

required

Target API version

Example:

project_id

string

required

Project ID retrieved by calling the "Project List" endpoint

Example:

6582ed0344adfe123d04f772

Header Params

x-api-key

string

required

Example:

1234abcd

string

optional

use text/xml if XML is required

Example:

application/json

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success — JSON

application/json

Body

array of:

integer

required

project_id

integer

required

text

string

required

style

string

required

is_strategic_imperative

integer

required

description

string | null

required

Example

[
    {
        "id": 1,
        "project_id": 1,
        "text": "Aspirational",
        "style": "emerald",
        "is_strategic_imperative": 0,
        "description": null
    },
    {
        "id": 2,
        "project_id": 1,
        "text": "Strategic Imperative 1",
        "style": "amethyst",
        "is_strategic_imperative": 1,
        "description": "A strategic imperative example."
    }
]

🟢200Success — XML

🟠401Unauthorized — JSON

🟠401Unauthorized — XML

🔴500Server Error — JSON

🔴500Server Error — XML