Settings Tags

List Tags

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

List of tags

application/json

totalRowsnumberOptional

400

Bad Request

application/json

401

Not Authorized

application/json

500

Unexpected error

application/json

get/settings/tags

HTTPcURLJavaScriptPython

GET /v2/settings/tags HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalRows": 1,
  "rows": [
    {
      "id": "urgent",
      "label": "Urgent",
      "color": "#ff0000"
    }
  ]
}

Create Tag

post

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

labelstringRequired

The display label of the tag.

colorstringOptional

The color of the tag (hex code).

Responses

200

Successfully created tag

application/json

idstringRequired

The unique ID of the tag.

labelstringRequired

The display label of the tag.

colorstringRequired

The color of the tag (hex code)

400

Bad Request

application/json

401

Not Authorized

application/json

409

Conflict - Tag already exists

application/json

500

Unexpected error

application/json

post/settings/tags

HTTPcURLJavaScriptPython

POST /v2/settings/tags HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "label": "High Priority",
  "color": "#FF5733"
}

{
  "id": "urgent",
  "label": "Urgent",
  "color": "#ff0000"
}

Retrieve Tag

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Tag

Responses

200

Details about the tag

application/json

idstringRequired

The unique ID of the tag.

labelstringRequired

The display label of the tag.

colorstringRequired

The color of the tag (hex code)

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

get/settings/tags/{id}

HTTPcURLJavaScriptPython

GET /v2/settings/tags/{id} HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "urgent",
  "label": "Urgent",
  "color": "#ff0000"
}

Update Tag

put

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Tag

Body

application/json

idstringRequired

The unique ID of the tag.

labelstringRequired

The display label of the tag.

colorstringRequired

The color of the tag (hex code)

Responses

200

Successfully updated tag

application/json

idstringRequired

The unique ID of the tag.

labelstringRequired

The display label of the tag.

colorstringRequired

The color of the tag (hex code)

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

put/settings/tags/{id}

HTTPcURLJavaScriptPython

PUT /v2/settings/tags/{id} HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "id": "urgent",
  "label": "Urgent",
  "color": "#ff0000"
}

{
  "id": "urgent",
  "label": "Urgent",
  "color": "#ff0000"
}

Delete Tag

delete

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Tag

Responses

204

Tag successfully deleted

No content

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

delete/settings/tags/{id}

HTTPcURLJavaScriptPython

DELETE /v2/settings/tags/{id} HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content