Tags

You can use the API to get or set tags.

The Tag model

Key

Type

Description

id

String

The unique identifier for the tag which is given by Tiledesk.

tag

String

The tag name.

color

String

The tag hexadecimal color

attributes

Object

The custom attributes which are set for the tag.

createdAt

String

The time (ISO-8601 date string) when the tag was created.

updatedAt

String

The time (ISO-8601 date string) when the tag was updated.

createdBy

String

The unique identifier of the row creator

id_project

String

The unique identifier of the project

get
Get all tags

https://api.tiledesk.com/v2/:project_id/tags
Allows an account to list all the tags.
Request
Response
Request
Path Parameters
project_id
required
string
the Project Id is a unique code assigned to your project when you create it in Tiledesk.
Headers
Authorization
required
string
authorization token. Basic Auth or JWT
Query Parameters
sortField
optional
string
what field to sort the results by. Default field is createdAt
direction
optional
string
sort direction: 1 or -1. Return the results in ascending (1) or descending (-1) order. defaults to desc
page
optional
number
what page of results to fetch. defaults to first page.
Response
200: OK
[
{
"_id":"5e67b8bafb930c0017aa4e42",
"tag":"tag1",
"color":"#66C549",
"id_project":"5e5d40b2bd0a9b00179ff3cd",
"createdBy":"5e09d16d4d36110017506d7f",
"createdAt":"2020-03-10T15:56:42.374Z",
"updatedAt":"2020-03-10T15:56:42.374Z",
"__v":0
},
{
"_id":"5e67b737fb930c0017aa4e40",
"tag":"important",
"color":"#43B1F2",
"id_project":"5e5d40b2bd0a9b00179ff3cd",
"createdBy":"5e09d16d4d36110017506d7f",
"createdAt":"2020-03-10T15:50:15.759Z",
"updatedAt":"2020-03-10T15:50:15.759Z",
"__v":0
},

get
Get a tag by id

https://api.tiledesk.com/v2/:project_id/tags/:id
Request
Response
Request
Path Parameters
id
required
string
the tag identifier
project_id
required
string
The project_id is a unique code assigned to your project when you create it in Tiledesk
Headers
Authorization
required
string
authorization token. Basic Auth or JWT
Content-Type
required
string
use "application/json" value
Response
200: OK
{
"_id":"5e67b737fb930c0017aa4e40",
"tag":"important",
"color":"#43B1F2",
"id_project":"5e5d40b2bd0a9b00179ff3cd",
"createdBy":"5e09d16d4d36110017506d7f",
"createdAt":"2020-03-10T15:50:15.759Z",
"updatedAt":"2020-03-10T15:50:15.759Z",
"__v":0
}

post
Create a new tag

https://api.tiledesk.com/v2/:project_id/tags
Request
Response
Request
Path Parameters
project_id
required
string
The project_id is a unique code assigned to your project when you create it in Tiledesk
Headers
Authorization
required
string
authorization token. Basic Auth or JWT
Content-Type
required
string
use "application/json" value
Body Parameters
tag
required
string
the tag name
color
optional
string
the tag color
attributes
optional
object
The tag custom attributes
Response
200: OK
{
"_id":"5e67b737fb930c0017aa4e40",
"tag":"important",
"color":"#43B1F2",
"id_project":"5e5d40b2bd0a9b00179ff3cd",
"createdBy":"5e09d16d4d36110017506d7f",
"createdAt":"2020-03-10T15:50:15.759Z",
"updatedAt":"2020-03-10T15:50:15.759Z",
"__v":0
}

put
Update a tag by id

https://api.tiledesk.com/v2/:project_id/tags/:id
Request
Response
Request
Path Parameters
project_id
required
string
The project_id is a unique code assigned to your project when you create it in Tiledesk
id
required
string
The id is the tag indentifier.
Headers
Authorization
required
string
authorization token. Basic Auth or JWT
Content-Type
required
string
use "application/json" value
Body Parameters
tag
required
string
the tag name
color
optional
string
the tag color
attributes
optional
object
The tag custom attributes
Response
200: OK
{
"_id":"5e67b737fb930c0017aa4e40",
"tag":"important",
"color":"#43B1F2",
"id_project":"5e5d40b2bd0a9b00179ff3cd",
"createdBy":"5e09d16d4d36110017506d7f",
"createdAt":"2020-03-10T15:50:15.759Z",
"updatedAt":"2020-03-10T15:50:15.759Z",
"__v":0
}

delete
Delete a tag by id

https://api.tiledesk.com/v2/:project_id/tags/:id
Request
Response
Request
Path Parameters
project_id
required
string
The project_id is a unique code assigned to your project when you create it in Tiledesk
id
required
string
The id is the tag indentifier.
Headers
Authorization
required
string
authorization token. Basic Auth or JWT
Response
200: OK
...