Projects
id — String The unique identifier for the project which is given by Tiledesk.
name — String The project name.
activeOperatingHours — Boolean 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 a list of projects the user belongs
GET https://api.tiledesk.com/v3/projects/
Headers
Authorization — string Authorization token. Basic Auth or JWT. Minimum role: user
Successful response (200) — example
Get the project detail
GET https://api.tiledesk.com/v3/projects/:project_id
Path parameters
project_id — string The Project Id is a unique code assigned to your project when you create it in Tiledesk.
Headers
Authorization — string Authorization token. Basic Auth or JWT. Minimum role: agent
Successful response (200) — example
Return the available agents
GET https://api.tiledesk.com/v3/projects/:project_id/users/availables
Return the available agents evaluating the general operating hours of the project and agents chat load (with Smart Assignment enabled).
Path parameters
project_id — string The Project Id is a unique code assigned to your project when you create it in Tiledesk.
Query parameters
raw — Boolean If true only agents status is considered (the general operating hours of the project are not considered)
Headers
Authorization — string Authorization token. Basic Auth or JWT. Minimum role: user
Successful response (200) — example
Return if the project is open regarding operating hours
GET https://api.tiledesk.com/v3/projects/:project_id/isopen
Path parameters
project_id — string The Project Id is a unique code assigned to your project when you create it in Tiledesk.
Headers
Authorization — string Authorization token. Basic Auth or JWT. Minimum role: guest
Successful response (200) — example
Update the project (Widget Settings)
PUT https://api.tiledesk.com/v3/projects/:project_id/availables
Path parameters
project_id — string The Project Id is a unique code assigned to your project when you create it in Tiledesk.
Headers
Authorization — string Authorization token. Basic Auth or JWT. Minimum role: user
Request body
widget — Object The object containing the widget configuration parameters (see example)
Request body example
Example curl
Related
Previous: Activities — https://developer.tiledesk.com/apis/rest-api/activities
Next: Team — https://developer.tiledesk.com/apis/rest-api/team
Last updated 1 year ago
Was this helpful?