Projects

The Project model

Key

Type

Description

id

String

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

name

String

The project name.

activeOperatingHours

Boolena

Determine if the operating hours option is enabled

operatingHours

Object

The operating hours settings.

settings

Object

The project settings

widget

Object

The widget settings.

profile

Object

The project profile object

status

Number

The project status. Permitted values: 100 active, 0 disabled

createdAt

String

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

updatedAt

String

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

createdBy

String

The unique identifier of the row creator

get
Get a list of projects the user belongs

https://api.tiledesk.com/v2/projects/
Request
Response
Request
Headers
Authorization
required
string
authorization token. Basic Auth or JWT
Response
200: OK
[
{
"_id":"5acdc6d86fb82500141d56c9",
"updatedAt":"2019-01-31T18:09:53.417Z",
"createdAt":"2018-04-11T08:27:04.509Z",
"id_project":{
"versions":30,
"_id":"5acba41a213ae3001451b723",
"updatedAt":"2019-01-29T12:01:06.793Z",
"createdAt":"2018-04-09T17:34:18.064Z",
"name":"conversational landing page",
"createdBy":"5aabade839db7d001477d3d5",
"__v":0,
"profile":{
"name":"free",
"trialDays":30,
"agents":0,
"type":"free"
},
"channels":[
{
"name":"chat21"
}
],
"trialExpired":true,
"trialDaysLeft":680,
"isActiveSubscription":false,
"id":"5acba41a213ae3001451b723"
},
"id_user":"5aaa99024c3b110014b478f0",
"role":"admin",
"createdBy":"5aabade839db7d001477d3d5",
"__v":0,
"user_available":true,
"id":"5acdc6d86fb82500141d56c9"
},
...
]

get
Get the project detail

https://api.tiledesk.com/v2/projects/:project_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.
Headers
Authorization
required
string
authorization token. Basic Auth or JWT
Response
200: OK
{
"versions":30,
"_id":"5df2240cecd41b00173a06bb",
"name":"000000",
"activeOperatingHours":true,
"createdBy":"5aaa99024c3b110014b478f0",
"profile":{
"name":"free",
"trialDays":30,
"agents":0,
"type":"free"
},
"channels":[
{
"name":"chat21"
}
],
"createdAt":"2019-12-12T11:27:08.548Z",
"updatedAt":"2020-01-08T10:53:12.844Z",
"__v":0,
"operatingHours":"{\"0\":[{\"start\":\"09:00\",\"end\":\"13:00\"},{\"start\":\"14:00\",\"end\":\"18:00\"}],\"1\":[{\"start\":\"09:00\",\"end\":\"13:00\"},{\"start\":\"14:00\",\"end\":\"18:00\"}],\"tzname\":\"Europe/Rome\"}",
"trialExpired":false,
"trialDaysLeft":-4,
"isActiveSubscription":false,
"id":"5df2240cecd41b00173a06bb"
}

get
Return the available agents

https://api.tiledesk.com/v2/projects/:project_id/users/availables
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
optional
string
authorization token. Basic Auth or JWT
Response
200: OK
[
{
"id":"5aaa99024c3b110014b478f0",
"firstname":"Andrea"
},
{
"id":"5de9200d6722370017731969",
"firstname":"Nuovopre"
}
]

get
Return if the project is open regarding operating hours

https://api.tiledesk.com/v2/projects/:project_id/isopen
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
optional
string
authorization token. Basic Auth or JWT
Response
200: OK
{"isopen":false}