Groups

The Group model

Key

Type

Description

id

String

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

name

String

The group name.

members

Array

The group members

trashed

Boolean

Determine if the group is deleted

attributes

Object

The custom attributes which are set for the group.

createdAt

String

The time when the group was created.

updatedAt

String

The time when the group was updated.

createdBy

String

The unique identifier of the row creator

id_project

String

The unique identifier of the project

get
Get all groups

https://api.tiledesk.com/v1/:project_id/groups
Allows an account to list all the groups of the 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
Response
200: OK
[
{
"_id":"5c34b5149f22a7001681e887",
"updatedAt":"2019-01-08T14:35:09.621Z",
"createdAt":"2019-01-08T14:35:00.625Z",
"name":"gruppo1",
"trashed":false,
"id_project":"5b55e806c93dde00143163dd",
"createdBy":"5ab0f3fa57066e0014bfd71e",
"__v":0,
"members":[
"5ad5bd40c975820014ba9009"
]
},
{
"_id":"5c34b52a9f22a7001681e888",
"updatedAt":"2019-01-08T14:35:29.678Z",
"createdAt":"2019-01-08T14:35:22.489Z",
"name":"gruppo2",
"trashed":false,
"id_project":"5b55e806c93dde00143163dd",
"createdBy":"5ab0f3fa57066e0014bfd71e",
"__v":0,
"members":[
"5ab0f3fa57066e0014bfd71e"
]
}
]

Example

curl -v -X GET -u andrea.leo@f21.it:123456 https://api.tiledesk.com/v1/5b55e806c93dde00143163dd/groups

get
Get the group by id

https://api.tiledesk.com/v1/:project_id/groups/:id
Fetche the group by his or her id
Request
Response
Request
Path Parameters
id
required
string
the group 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
Response
200: OK
{
"_id":"5c34b52a9f22a7001681e888",
"updatedAt":"2019-01-08T14:35:29.678Z",
"createdAt":"2019-01-08T14:35:22.489Z",
"name":"gruppo2",
"trashed":false,
"id_project":"5b55e806c93dde00143163dd",
"createdBy":"5ab0f3fa57066e0014bfd71e",
"__v":0,
"members":[
"5ab0f3fa57066e0014bfd71e"
]
}

Example:

curl -v -X GET -u andrea.leo@f21.it:123456 https://api.tiledesk.com/v1/5b55e806c93dde00143163dd/groups/5c34b52a9f22a7001681e888

post
Create a new group

https://api.tiledesk.com/v1/:project_id/groups
Allows to add more groups.
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
name
required
string
The group name
members
required
array
The group members ids.
Response
200: OK
{
"_id":"5c34b52a9f22a7001681e888",
"updatedAt":"2019-01-08T14:35:29.678Z",
"createdAt":"2019-01-08T14:35:22.489Z",
"name":"gruppo2",
"trashed":false,
"id_project":"5b55e806c93dde00143163dd",
"createdBy":"5ab0f3fa57066e0014bfd71e",
"__v":0,
"members":[
"5ab0f3fa57066e0014bfd71e"
]
}

Example:

curl -v -X POST -H 'Content-Type: application/json' -u andrea.leo@f21.it:123456 -d '{"name":"new group1", "members":["5ab0f3fa57066e0014bfd71e"]}' https://api.tiledesk.com/v1/5b55e806c93dde00143163dd/groups

put
Update a group

https://api.tiledesk.com/v1/:project_id/groups/:id
Allows to update a group.
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 group identifier
Headers
Authorization
required
string
authorization token. Basic Auth or JWT
Content-Type
required
string
use "application/json" value
Body Parameters
name
required
string
The group name
members
required
array
The group members ids.
Response
200: OK
{
"_id":"5c34b52a9f22a7001681e888",
"updatedAt":"2019-01-08T14:35:29.678Z",
"createdAt":"2019-01-08T14:35:22.489Z",
"name":"gruppo2",
"trashed":false,
"id_project":"5b55e806c93dde00143163dd",
"createdBy":"5ab0f3fa57066e0014bfd71e",
"__v":0,
"members":[
"5ab0f3fa57066e0014bfd71e"
]
}

Example:

curl -v -X PUT -H 'Content-Type: application/json' -u andrea.leo@f21.it:123456 -d '{"name":"new group1", "members":["5ab0f3fa57066e0014bfd71e"]}' https://api.tiledesk.com/v1/5b55e806c93dde00143163dd/groups/groups/5c34b52a9f22a7001681e888

delete
Delete a group

https://api.tiledesk.com/v1/:project_id/groups/:id
Allows to delete a group.
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 group identifier
Headers
Authorization
required
string
authorization token. Basic Auth or JWT
Response
200: OK
{
"_id":"5c34b52a9f22a7001681e888",
"updatedAt":"2019-01-08T14:35:29.678Z",
"createdAt":"2019-01-08T14:35:22.489Z",
"name":"gruppo2",
"trashed":false,
"id_project":"5b55e806c93dde00143163dd",
"createdBy":"5ab0f3fa57066e0014bfd71e",
"__v":0,
"members":[
"5ab0f3fa57066e0014bfd71e"
]
}

Example:

curl -v -X DELETE -H 'Content-Type: application/json' -u andrea.leo@f21.it:123456 https://api.tiledesk.com/v1/5b55e806c93dde00143163dd/groups/5c34b52a9f22a7001681e888