Team

The Model

Key

Type

Description

id

String

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

role

String

The teammate role. Values: owner, agent, admin, user, guest

user_available

Boolean

Dermine if the teammate is available or unavailable to accept requests

id_user

Object

The user object referenced by the teammate

max_served_chat

Number

Number of chats that agent is allowed to take at one time (Only Enterprise)

number_assigned_requests

Number

Number of active request for the teammate (Only Enterprise)

isBusy

Boolean

Determine if the teammate is busy (Only Enterprise)

attributes

Object

The custom attributes which are set for the teammate.

createdAt

String

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

updatedAt

String

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

createdBy

String

The unique identifier of the row creator

id_project

String

The unique identifier of the project

get
Get the team

https://api.tiledesk.com/v1/:project_id/project_users
Return the team members and availability
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
[
{
"_id":"5df2240cecd41b00173a06bc",
"id_project":"5df2240cecd41b00173a06bb",
"id_user":{
"_id":"5aaa99024c3b110014b478f0",
"email":"andrea.leo@frontiere21.it",
"firstname":"Andrea",
"lastname":"Leo",
"emailverified":true,
"__v":0,
"resetpswrequestid":""
},
"role":"owner",
"user_available":true,
"createdBy":"5aaa99024c3b110014b478f0",
"createdAt":"2019-12-12T11:27:08.581Z",
"updatedAt":"2019-12-12T11:27:08.581Z",
"__v":0
},
{
"_id":"5df34ab80bc923001792e274",
"id_project":"5df2240cecd41b00173a06bb",
"id_user":{
"_id":"5de9200d6722370017731969",
"email":"nuovopre@f21test.it",
"firstname":"Nuovopre",
"lastname":"Pre",
"emailverified":false,
"createdAt":"2019-12-05T15:19:41.296Z",
"updatedAt":"2019-12-05T15:19:41.296Z",
"__v":0
},
"role":"admin",
"user_available":true,
"createdBy":"5aaa99024c3b110014b478f0",
"createdAt":"2019-12-13T08:24:24.586Z",
"updatedAt":"2020-01-04T09:45:26.331Z",
"__v":0
},
{
"_id":"5e09e36d3030640017718ee2",
"id_project":"5df2240cecd41b00173a06bb",
"id_user":{
"_id":"5e09e36d3030640017718edf",
"email":"magnegerki@enayu.com",
"firstname":"magnegerki",
"lastname":"magnegerki",
"emailverified":false,
"createdAt":"2019-12-30T11:45:49.123Z",
"updatedAt":"2019-12-30T11:45:49.123Z",
"__v":0
},
"role":"agent",
"user_available":false,
"createdBy":"5aaa99024c3b110014b478f0",
"createdAt":"2019-12-30T11:45:49.419Z",
"updatedAt":"2020-01-04T09:45:27.207Z",
"__v":0
}
]

get
Get a teammate by id

https://api.tiledesk.com/v1/:project_id/project_users/:project_user_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.
project_user_id
required
string
The teammate identifier.
Headers
Authorization
required
string
authorization token. Basic Auth or JWT
Response
200: OK
{
"_id":"5df2240cecd41b00173a06bc",
"id_project":"5df2240cecd41b00173a06bb",
"id_user":{
"_id":"5aaa99024c3b110014b478f0",
"email":"andrea.leo@frontiere21.it",
"firstname":"Andrea",
"lastname":"Leo",
"emailverified":true,
"__v":0,
"resetpswrequestid":""
},
"role":"owner",
"user_available":true,
"createdBy":"5aaa99024c3b110014b478f0",
"createdAt":"2019-12-12T11:27:08.581Z",
"updatedAt":"2019-12-12T11:27:08.581Z",
"__v":0
}

get
Get a teammate by user id

https://api.tiledesk.com/v1/:project_id/project_users/users/:user_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.
user_id
required
string
The user identifier.
Headers
Authorization
required
string
authorization token. Basic Auth or JWT
Response
200: OK
{
"_id":"5df2240cecd41b00173a06bc",
"id_project":"5df2240cecd41b00173a06bb",
"id_user":{
"_id":"5aaa99024c3b110014b478f0",
"email":"andrea.leo@frontiere21.it",
"firstname":"Andrea",
"lastname":"Leo",
"emailverified":true,
"__v":0,
"resetpswrequestid":""
},
"role":"owner",
"user_available":true,
"createdBy":"5aaa99024c3b110014b478f0",
"createdAt":"2019-12-12T11:27:08.581Z",
"updatedAt":"2019-12-12T11:27:08.581Z",
"__v":0
}

post
Invite an agent

https://api.tiledesk.com/v1/:project_id/project_users
Invite an agent to a project.
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
email
required
string
the agent email address
role
required
string
the agent role. Accepted values: agent, admin
firstname
optional
string
the firstname of the agent
lastname
optional
string
the lastname of the agent
user_available
optional
boolean
the initial agent status. Available (true) or unavailable (false).
Response
200: OK
{
...
}

put
Update a teammate by id

https://api.tiledesk.com/v1/:project_id/project_users/:project_user_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
project_user_id
required
string
The teammate identifier.
Headers
Authorization
required
string
authorization token. Basic Auth or JWT
Content-Type
required
string
use "application/json" value
Body Parameters
role
optional
string
The teammate role. Permitted values: admin, agent.
user_available
optional
boolean
The teammate availability. True for available, false for unavailable. Default is true
max_served_chat
optional
number
The number of concurrent chats the teammate can take at once.
attributes
optional
object
The teammate custom attributes
Response
200: OK
{
..
}

delete
Leave a project

https://api.tiledesk.com/v1/:project_id/project_users/:project_user_id
Leave an agent from a project.
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
project_user_id
required
string
The teammate identifier.
Headers
Authorization
required
string
authorization token. Basic Auth or JWT
Response
200: OK
{
...
}