# Tatodesk API
Click a topic below to directly access the detailed documentation for each item:
In-Person Service:
* [List Companies by user](#post-listar-empresas-por-usuario);
* [List Service Units by User](#post-lista-unidades-de-atendimento-por-usuario);
* [List Service Classifications](#post-lista-classificacoes-de-atendimento);
* [List Service Categories](#post-lista-categorias-de-atendimento);
* [List Service Types](#post-lista-tipos-de-atendimento);
* [List Form Fields](#post-lista-campos-do-formulario);
* [Create In-Person Service](#post-cria-atendimento-presencial);
* [List Companies for the Custom Link](#post-listar-empresas-do-link-personalizado);
* [List Categories for Scheduling](#post-listar-categorias-para-agendamento);
* [List Categories of the Custom Link](#post-listar-categorias-do-link-personalizado);
* [List Service Types for Scheduling;](#post-listar-tipos-de-atendimento-para-agendamento)
* [List Regions for Scheduling](#post-listar-regioes-para-agendamento);
* [List Service Units for Scheduling](#post-listar-unidades-de-atendimento-para-agendamento);
* [List Dates for Scheduling](#post-listar-datas-para-agendamento);
* [List Periods for Scheduling](#post-listar-periodos-para-agendamento);
* [List Times for Scheduling](#post-listar-horarios-para-agendamento);
* [Create Appointment](#post-criar-agendamento);
* [Query Appointment](#post-consultar-agendamento);
* [Get In-Person Service](#post-obter-atendimento-presencial);
* [Add Attachments](#post-adicionar-anexos);
Marketing:
* [Send Notification via E-mail](#post-enviar-notificacoes-via-e-mail);
WhatsApp:
* [Add Attachments](#post-adicionar-anexos);
* [Send Notification via WhatsApp](#post-envia-notificacao-via-whatsapp);
* [Send Notification via WhatsApp - Using Media Upload](#post-envia-notificacao-via-whatsapp-usando-upload-de-midia);
SMS:
* [Send notification via SMS](#post-envia-notificacao-via-sms);
Data API:
* [Digital Services Report](#post-relatorio-de-atendimentos-digitais);
* [Campaigns Report](#post-relatorio-de-campanhas);
* [In-Person Services Report](#post-relatorio-de-atendimentos-presenciais);
* [Tickets Report](#post-relatorio-de-tickets);
* [Search by Protocol](#post-busca-por-protocolo);
* [Sessions Report](#post-relatorio-de-sessoes);
* [Grouped Journey Report](#post-relatorio-de-jornada-agrupado);
* [Detailed Journey Report](#post-relatorio-de-jornada-detalhado);
* [Ad-hoc Notifications Report](/tato-docs-en/platform/marketing/campaigns/reports/individual-notifications-report.md);
* [Get Session](#post-obter-sessao);
* [List Reviews](#post-lista-avaliacoes);
CRM:
* [List Objects](#post-lista-objetos);
* [Create Object](#post-cria-objeto);
* [Edit Object](#post-edita-objeto);
* [Delete Object](#post-deletar-objeto);
Contact Center:
* [List Departments](#post-listar-departamentos);
* [List Service Groups](#post-listar-grupo-de-atendimentos);
* [List Specialties](#post-listar-especialidades);
* [List Subspecialties](#post-listar-subspecialidades);
* [List Areas](#post-listar-areas);
* [List Subareas](#post-listar-subareas);
* [List Service Schedules](#post-listar-horarios-de-atendimento);
* [List Service Schedule Exceptions](#post-listar-excecoes-do-horario-de-atendimento);
Pulse:
* [Create Application Session](#post-criar-sessao-de-aplicativo);
* [Register Event](#post-registrar-evento);
* [List Journeys](#post-listar-jornadas);
* [Get Form](#post-formularios);
* [Register Form Responses](#post-registrar-respostas-do-formulario).
### In-Person Service
### Post List companies by user
https://api.tatodesk.com/dl/pa/listCompaniesByUser
{% hint style="info" %}
You must use an **API-KEY** linked to an authorized user to make the request.
{% endhint %}
**Request Example**
{% code lineNumbers="true" %}
```json
curl --location 'https://api.tatodesk.com/dl/pa/listCompaniesByUser' \
--data '{
"isActive": 1
}'
```
{% endcode %}
**Response Example**
{% code lineNumbers="true" %}
```json
{
"companies": [
{
"ID": 1,
"name": "Tatodesk",
"accountID": 1,
"isActive": 1,
"isDelete": 2,
"createdAt": "2022-01-28T13:33:20.264Z",
"updatedAt": "2022-06-20T17:36:35.945Z"
},
{
"ID": 13,
"name": "Tatodesk 2",
"accountID": 1,
"isActive": 1,
"isDelete": 2,
"createdAt": "2022-11-17T18:28:07.607Z",
"updatedAt": "2022-11-17T18:28:07.608Z"
},
{
"ID": 41,
"name": "TechSoluções",
"accountID": 1,
"isActive": 1,
"isDelete": 2,
"createdAt": "2024-01-03T14:11:00.238Z",
"updatedAt": "2024-01-03T14:11:00.238Z"
}
],
"error": null
}
```
{% endcode %}
### Post List Service Units by User
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/dl/pa/listAttendanceUnitsByUser
```
{% endcode %}
{% hint style="info" %}
You must use an **API-KEY** linked to an authorized user to make the request.
{% endhint %}
**Request Example**
{% code lineNumbers="true" %}
```json
curl --location 'https://api.tatodesk.com/dl/pa/listAttendanceUnitsByUser' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
"companyID": 1,
"isActive": 1
}'
```
{% endcode %}
**Response Example**
{% code lineNumbers="true" %}
```json
{
"attendanceUnits": [
{
"ID": 1,
"name": "Unidade Recife Antigo",
"address": "Rua Marquês de Olinda, 123",
"companyID": 1,
"companyName": "Tatodesk"
},
{
"ID": 83,
"name": "Unidade Central",
"address": null,
"companyID": 1,
"companyName": "Tatodesk"
},
{
"ID": 36,
"name": "Unidade Madalena",
"address": "Rua Madalena, 223",
"companyID": 1,
"companyName": "Tatodesk"
},
{
"ID": 288,
"name": "Unidade Central Limoeiro",
"address": "Rua C Bairro João Ernesto",
"companyID": 1,
"companyName": "Tatodesk"
}
],
"error": null
}
```
{% endcode %}
### Post List Service Classifications
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/dl/pa/listAttendanceClassifications
```
{% endcode %}
**Request Example**
{% code lineNumbers="true" %}
```json
curl --location --request POST 'https://api.tatodesk.com/dl/pa/listAttendanceClassifications' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data ''
```
{% endcode %}
**Response Example**
{% code lineNumbers="true" %}
```json
{
"attendanceClassifications": [
{
"ID": 1,
"name": "Common",
"accountID": 1,
"isActive": 1,
"isDeleted": 2,
"abbreviation": "CM",
"isHighPriority": 2,
"createdAt": "2022-01-28T17:17:48.016Z",
"updatedAt": "2022-07-21T14:34:43.757Z"
},
{
"ID": 4,
"name": "Pregnant",
"accountID": 1,
"isActive": 1,
"isDeleted": 2,
"abbreviation": "G",
"isHighPriority": 2,
"createdAt": "2022-02-17T19:16:54.135Z",
"updatedAt": "2024-01-12T13:21:57.998Z"
},
{
"ID": 2,
"name": "Preferential",
"accountID": 1,
"isActive": 1,
"isDeleted": 2,
"abbreviation": "PRL",
"isHighPriority": 2,
"createdAt": "2022-01-28T17:17:59.806Z",
"updatedAt": "2022-01-28T17:17:59.806Z"
}
],
"error": null
}
```
{% endcode %}
### Post List Service Categories
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/dl/pa/listAttendanceTypeCategories
```
{% endcode %}
**Request Example**
{% code lineNumbers="true" %}
```json
curl --location 'https://api.tatodesk.com/dl/pa/listAttendanceTypeCategories' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
"attendanceUnitID": 53
}'
```
{% endcode %}
**Response Example**
{% code lineNumbers="true" %}
```json
{
"attendanceTypeCategories": [
{
"ID": 11,
"name": "2nd Copy",
"isActive": 1,
"isDeleted": 2,
"accountID": 58,
"contactFormID": 19,
"allowSchedule": 2
},
{
"ID": 22,
"name": "Measurement",
"isActive": 1,
"isDeleted": 2,
"accountID": 58,
"contactFormID": 19,
"allowSchedule": 2
},
{
"ID": 25,
"name": "Registration Update",
"isActive": 1,
"isDeleted": 2,
"accountID": 58,
"contactFormID": 19,
"allowSchedule": 2
},
{
"ID": 18,
"name": "Signboard",
"isActive": 1,
"isDeleted": 2,
"accountID": 58,
"contactFormID": 19,
"allowSchedule": 2
},
{
"ID": 21,
"name": "Customer Requested Cut",
"isActive": 1,
"isDeleted": 2,
"accountID": 58,
"contactFormID": 19,
"allowSchedule": 2
},
{
"ID": 48,
"name": "Lack of supply",
"isActive": 1,
"isDeleted": 2,
"accountID": 58,
"contactFormID": 19,
"allowSchedule": 1
},
{
"ID": 34,
"name": "Connection Inspection",
"isActive": 1,
"isDeleted": 2,
"accountID": 58,
"contactFormID": 19,
"allowSchedule": 1
},
{
"ID": 14,
"name": "New Water/Sewage Connection",
"isActive": 1,
"isDeleted": 2,
"accountID": 58,
"contactFormID": 19,
"allowSchedule": 2
},
{
"ID": 28,
"name": "Pressure Measurement",
"isActive": 1,
"isDeleted": 2,
"accountID": 58,
"contactFormID": 19,
"allowSchedule": 2
},
{
"ID": 49,
"name": "Micromeasurement ",
"isActive": 1,
"isDeleted": 2,
"accountID": 58,
"contactFormID": 19,
"allowSchedule": 1
},
{
"ID": 19,
"name": "Others",
"isActive": 1,
"isDeleted": 2,
"accountID": 58,
"contactFormID": 19,
"allowSchedule": 2
},
{
"ID": 31,
"name": "Installment",
"isActive": 1,
"isDeleted": 2,
"accountID": 58,
"contactFormID": 19,
"allowSchedule": 2
},
{
"ID": 26,
"name": "Rebilling",
"isActive": 1,
"isDeleted": 2,
"accountID": 58,
"contactFormID": 19,
"allowSchedule": 2
},
{
"ID": 33,
"name": "Reconnection",
"isActive": 1,
"isDeleted": 2,
"accountID": 58,
"contactFormID": 19,
"allowSchedule": 1
},
{
"ID": 20,
"name": "Signboard Relocation",
"isActive": 1,
"isDeleted": 2,
"accountID": 58,
"contactFormID": 19,
"allowSchedule": 2
},
{
"ID": 24,
"name": "Registration Review",
"isActive": 1,
"isDeleted": 2,
"accountID": 58,
"contactFormID": 19,
"allowSchedule": 2
},
{
"ID": 29,
"name": "Water Meter Replacement",
"isActive": 1,
"isDeleted": 2,
"accountID": 58,
"contactFormID": 19,
"allowSchedule": 2
},
{
"ID": 30,
"name": "Social Tariff",
"isActive": 1,
"isDeleted": 2,
"accountID": 58,
"contactFormID": 19,
"allowSchedule": 2
},
{
"ID": 16,
"name": "Change of Ownership",
"isActive": 1,
"isDeleted": 2,
"accountID": 58,
"contactFormID": 19,
"allowSchedule": 2
},
{
"ID": 17,
"name": "Leaks",
"isActive": 1,
"isDeleted": 2,
"accountID": 58,
"contactFormID": 19,
"allowSchedule": 2
}
],
"error": null
}
```
{% endcode %}
### Post List Service Types
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/dl/pa/listAttendanceTypes
```
{% endcode %}
**Request Example**
{% code lineNumbers="true" %}
```json
curl --location 'https://api.tatodesk.com/dl/pa/listAttendanceTypes' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
"attendanceUnitID": 58,
"attendanceTypeCategoryID": 11
}'
```
{% endcode %}
**Response Example**
{% code lineNumbers="true" %}
```json
{
"attendanceTypes": [
{
"ID": 28,
"name": "Issuance 2nd copy"
}
],
"error": null
}
```
{% endcode %}
### Post List Form Fields
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/dl/pa/listContactFormFields
```
{% endcode %}
**Request Example**
{% code lineNumbers="true" %}
```json
curl --location 'https://api.tatodesk.com/dl/pa/listContactFormFields' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
"attendanceTypeCategoryID":11,
"attendanceTypeIDs": [28],
"attendanceUnitID": 58
}'
```
{% endcode %}
**Response Example**
{% code lineNumbers="true" %}
```json
{
"contactFormFields": [
{
"ID": 115,
"contactFormID": 19,
"contactFormKeyID": 22,
"contactFormKeyName": "NAME",
"key": "Name",
"keyTypeID": 1,
"isRequired": 1,
"isActive": 1,
"sort": 1
},
{
"ID": 114,
"contactFormID": 19,
"contactFormKeyID": 24,
"contactFormKeyName": "PHONE",
"key": "Tel",
"keyTypeID": 5,
"isRequired": 1,
"isActive": 1,
"sort": 2
}
],
"error": null
}
```
{% endcode %}
### Post Create In-Person Service
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/dl/pa/createPresentialAttendance
```
{% endcode %}
**Request Example**
{% code lineNumbers="true" %}
```json
curl --location 'https://api.tatodesk.com/dl/pa/createPresentialAttendance' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data-raw '{
"attendanceClassificationID": 1,
"companyID": 1,
"attendanceUnitID": 1,
"attendanceTypeID": [140],
"contactFormFields": [
{
"contactFormKeyID": 19,
"key": "EMAIL",
"value": "email@email.com"
},
{
"contactFormKeyID": 1,
"key": "NAME",
"value": "Severino Silva"
},
{
"contactFormKeyID": 2,
"key": "CPF_CNPJ",
"value": "42052591079"
}
],
"userID": 1,
"contactFormID": 1
}'
```
{% endcode %}
**Response Example**
{% code lineNumbers="true" %}
```json
{
"attendance": {
"ID": 1783056,
"protocol": "20250408093423710",
"date": "2025-04-08T12:34:23.705Z",
"attendanceClassificationID": 1,
"sequence": 2,
"companyID": 1,
"attendanceUnitID": 1,
"statusID": 2,
"sequential": null,
"ticketWindowPeriodID": null,
"createdAt": "2025-04-08T12:34:23.705Z",
"updatedAt": "2025-04-08T12:34:23.705Z",
"accountID": 1,
"userID": null,
"allowServiceDelay": 2,
"reasonCancellationID": null,
"presentialAttendancePipelineID": null,
"pipelineStep": null,
"attendanceTime": null,
"waitingTime": null,
"lastTimeWaiting": "2025-04-08T12:34:23.705Z",
"lastTimeStarted": null,
"attendanceCode": "CM2",
"expiredAt": null,
"reasonBreakAttendanceID": null,
"displacementTime": null,
"pausedTime": null,
"nps": null,
"npsObservation": null,
"remoteAttendance": null,
"ticketWindowType": null
},
"attendanceLinks": {
"rateLink": "https://arate.tatodesk.com/fb?p=20250408093423710&plt=pa&a=1",
"documentSubmissionLinks": [
{
"name": "VIP Service in Fashion Stores",
"formName": "sergio form",
"link": "https://attendance-document.tatodesk.com/ds?p=20250408093423710&plt=presential-attendance&atdfid=2d7784e8-2a5f-4116-9df5-f4d551882905"
}
]
},
"error": null
}
```
{% endcode %}
#### Post List Companies for the Custom Link
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/pa/listCustomCompanies
```
{% endcode %}
**Request Example**
{% code lineNumbers="true" %}
```json
curl --location 'https://api.tatodesk.com/pa/listCustomCompanies' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
"token": "{{token}}"
}
'
```
{% endcode %}
**Response Example**
{% code lineNumbers="true" %}
```json
{
"companies": [
{
"ID": 1,
"name": "Tatodesk",
"accountID": 1,
"isActive": 1,
"isDelete": 2,
"createdAt": "2022-01-28T13:33:20.264Z",
"updatedAt": "2022-06-20T17:36:35.945Z"
},
{
"ID": 13,
"name": "Tatodesk 2",
"accountID": 1,
"isActive": 1,
"isDelete": 2,
"createdAt": "2022-11-17T18:28:07.607Z",
"updatedAt": "2022-11-17T18:28:07.608Z"
},
{
"ID": 41,
"name": "TechSoluções",
"accountID": 1,
"isActive": 1,
"isDelete": 2,
"createdAt": "2024-01-03T14:11:00.238Z",
"updatedAt": "2024-01-03T14:11:00.238Z"
},
{
"ID": 42,
"name": "EcoVida Sustainable Energy",
"accountID": 1,
"isActive": 1,
"isDelete": 2,
"createdAt": "2024-01-03T14:11:38.609Z",
"updatedAt": "2024-01-03T14:11:38.609Z"
},
{
"ID": 43,
"name": "FashionTrends\t",
"accountID": 1,
"isActive": 1,
"isDelete": 2,
"createdAt": "2024-01-03T14:11:47.727Z",
"updatedAt": "2024-01-03T14:11:47.727Z"
},
{
"ID": 44,
"name": "BioPharma Solutions",
"accountID": 1,
"isActive": 1,
"isDelete": 2,
"createdAt": "2024-01-03T14:11:59.119Z",
"updatedAt": "2024-01-03T14:11:59.119Z"
},
{
"ID": 45,
"name": "SkyConnect Telecom",
"accountID": 1,
"isActive": 1,
"isDelete": 2,
"createdAt": "2024-01-03T14:12:09.873Z",
"updatedAt": "2024-01-03T14:12:09.873Z"
},
{
"ID": 46,
"name": "GreenHarvest Organic Foods",
"accountID": 1,
"isActive": 1,
"isDelete": 2,
"createdAt": "2024-01-03T14:12:22.889Z",
"updatedAt": "2024-01-03T14:12:22.889Z"
},
{
"ID": 47,
"name": "InovaTech Consulting",
"accountID": 1,
"isActive": 1,
"isDelete": 2,
"createdAt": "2024-01-03T14:12:32.785Z",
"updatedAt": "2024-01-03T14:12:32.785Z"
},
{
"ID": 48,
"name": "RoboGenius Automatio",
"accountID": 1,
"isActive": 1,
"isDelete": 2,
"createdAt": "2024-01-03T14:12:44.758Z",
"updatedAt": "2025-06-13T13:52:27.540Z"
}
],
"error": null
}
```
{% endcode %}
#### Post List Categories for Scheduling
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/pa/listAttendanceTypeCategoriesForAppointment
```
{% endcode %}
**Description:**\
Returns all **service categories available for scheduling** in a specific company.
**Request Example**
{% code lineNumbers="true" %}
```json
curl --location 'https://api.tatodesk.com/pa/listAttendanceTypeCategoriesForAppointment' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
"companyID": 1
}
'
```
{% endcode %}
**Response Example**
{
"attendanceTypeCategories": [
{
"ID": 1,
"name": "Debt Negotiation",
"isActive": 1,
"isDeleted": 2,
"allowSchedule": 1,
"createdAt": "2022-01-28T17:16:52.497Z",
"updatedAt": "2022-06-22T19:26:12.152Z",
"accountID": 1,
"contactFormID": 2,
"companyID": 1
},
{
"ID": 2,
"name": "Register complaint",
"isActive": 1,
"isDeleted": 2,
"allowSchedule": 1,
"createdAt": "2022-01-28T17:09:42.696Z",
"updatedAt": "2024-05-21T18:47:24.065Z",
"accountID": 1,
"contactFormID": 30,
"companyID": 1
},
{
"ID": 8,
"name": "Others",
"isActive": 1,
"isDeleted": 2,
"allowSchedule": 1,
"createdAt": "2022-04-01T14:21:44.664Z",
"updatedAt": "2024-05-21T18:55:27.159Z",
"accountID": 1,
"contactFormID": 34,
"companyID": 1
},
{
"ID": 74,
"name": "Technical Support",
"isActive": 1,
"isDeleted": 2,
"allowSchedule": 1,
"createdAt": "2024-01-03T18:55:09.495Z",
"updatedAt": "2024-01-03T18:55:09.495Z",
"accountID": 1,
"contactFormID": 30,
"companyID": 1
},
{
"ID": 75,
"name": "Software Development",
"isActive": 1,
"isDeleted": 2,
"allowSchedule": 1,
"createdAt": "2024-01-03T18:55:29.979Z",
"updatedAt": "2024-01-03T18:55:29.979Z",
"accountID": 1,
"contactFormID": 30,
"companyID": 1
},
{
"ID": 76,
"name": "IT Consulting",
"isActive": 1,
"isDeleted": 2,
"allowSchedule": 1,
"createdAt": "2024-01-03T18:59:56.745Z",
"updatedAt": "2024-01-03T18:59:56.745Z",
"accountID": 1,
"contactFormID": 30,
"companyID": 1
},
{
"ID": 83,
"name": "Drug Development",
"isActive": 1,
"isDeleted": 2,
"allowSchedule": 1,
"createdAt": "2024-01-03T19:02:04.101Z",
"updatedAt": "2024-01-03T19:02:04.101Z",
"accountID": 1,
"contactFormID": 31,
"companyID": 1
}
],
"error": null
}
#### Post List Categories of the Custom Link
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/pa/listCustomAttendanceTypeCategories
```
{% endcode %}
**Description:**\
Returns the **categories associated with a custom scheduling link** identified by a `token`.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://api.tatodesk.com/pa/listCustomAttendanceTypeCategories' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
"token": "{{token}}"
}
'
```
{% endcode %}
**Response Example:**
{% code lineNumbers="true" %}
```json
{
"companies": [
{
"ID": 1,
"name": "Tatodesk",
"accountID": 1,
"isActive": 1,
"isDelete": 2,
"createdAt": "2022-01-28T13:33:20.264Z",
"updatedAt": "2022-06-20T17:36:35.945Z"
},
{
"ID": 13,
"name": "Tatodesk 2",
"accountID": 1,
"isActive": 1,
"isDelete": 2,
"createdAt": "2022-11-17T18:28:07.607Z",
"updatedAt": "2022-11-17T18:28:07.608Z"
},
{
"ID": 41,
"name": "TechSoluções",
"accountID": 1,
"isActive": 1,
"isDelete": 2,
"createdAt": "2024-01-03T14:11:00.238Z",
"updatedAt": "2024-01-03T14:11:00.238Z"
},
{
"ID": 42,
"name": "EcoVida Sustainable Energy",
"accountID": 1,
"isActive": 1,
"isDelete": 2,
"createdAt": "2024-01-03T14:11:38.609Z",
"updatedAt": "2024-01-03T14:11:38.609Z"
},
{
"ID": 43,
"name": "FashionTrends\t",
"accountID": 1,
"isActive": 1,
"isDelete": 2,
"createdAt": "2024-01-03T14:11:47.727Z",
"updatedAt": "2024-01-03T14:11:47.727Z"
},
{
"ID": 44,
"name": "BioPharma Solutions",
"accountID": 1,
"isActive": 1,
"isDelete": 2,
"createdAt": "2024-01-03T14:11:59.119Z",
"updatedAt": "2024-01-03T14:11:59.119Z"
},
{
"ID": 45,
"name": "SkyConnect Telecom",
"accountID": 1,
"isActive": 1,
"isDelete": 2,
"createdAt": "2024-01-03T14:12:09.873Z",
"updatedAt": "2024-01-03T14:12:09.873Z"
},
{
"ID": 46,
"name": "GreenHarvest Organic Foods",
"accountID": 1,
"isActive": 1,
"isDelete": 2,
"createdAt": "2024-01-03T14:12:22.889Z",
"updatedAt": "2024-01-03T14:12:22.889Z"
},
{
"ID": 47,
"name": "InovaTech Consulting",
"accountID": 1,
"isActive": 1,
"isDelete": 2,
"createdAt": "2024-01-03T14:12:32.785Z",
"updatedAt": "2024-01-03T14:12:32.785Z"
},
{
"ID": 48,
"name": "RoboGenius Automatio",
"accountID": 1,
"isActive": 1,
"isDelete": 2,
"createdAt": "2024-01-03T14:12:44.758Z",
"updatedAt": "2025-06-13T13:52:27.540Z"
}
],
"error": null
}
```
{% endcode %}
#### Post List Service Types for Scheduling
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/pa/listAttendanceTypesForAppointment
```
{% endcode %}
**Description:**\
Returns the **service types available** within a **specific category**, used in the next step of scheduling.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://api.tatodesk.com/pa/listAttendanceTypesForAppointment' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
"categoryID": 1
}
'
```
{% endcode %}
**Response Example:**
{% code lineNumbers="true" %}
```json
{
"attendanceTypes": [
{
"ID": 1,
"name": "Debt Installment",
"isActive": 1,
"isDeleted": 2,
"createdAt": "2022-01-28T17:17:29.254Z",
"updatedAt": "2023-12-20T17:05:55.953Z",
"attendanceTypeCategoryID": 1,
"contactFormID": 2,
"documentGroupID": 5,
"allowSchedule": 1,
"color": "#af2c86",
"price": "1.200.011.111,11",
"limitDatesGenerateGrid": 7,
"minimalTimeToAppointment": null,
"serviceTime": null,
"attendanceTime": null,
"accountID": 1,
"attendanceDocumentFormID": null
},
{
"ID": 27,
"name": "Debt Installment above one thousand reais",
"isActive": 1,
"isDeleted": 2,
"createdAt": "2022-06-28T13:45:13.200Z",
"updatedAt": "2023-11-16T20:01:52.482Z",
"attendanceTypeCategoryID": 1,
"contactFormID": 1,
"documentGroupID": 5,
"allowSchedule": 1,
"color": "#efafaf",
"price": "$111,111,111,111.00",
"limitDatesGenerateGrid": null,
"minimalTimeToAppointment": null,
"serviceTime": null,
"attendanceTime": null,
"accountID": 1,
"attendanceDocumentFormID": null
},
{
"ID": 145,
"name": "adauto test",
"isActive": 1,
"isDeleted": 2,
"createdAt": "2024-01-23T20:02:01.937Z",
"updatedAt": "2025-05-06T12:16:30.745Z",
"attendanceTypeCategoryID": 1,
"contactFormID": null,
"documentGroupID": null,
"allowSchedule": 1,
"color": "#38ba36",
"price": "0.00",
"limitDatesGenerateGrid": null,
"minimalTimeToAppointment": null,
"serviceTime": null,
"attendanceTime": null,
"accountID": 1,
"attendanceDocumentFormID": "8dac9611-eea7-4507-bb82-e046ebbec1e0"
},
{
"ID": 149,
"name": "test adauto service type",
"isActive": 1,
"isDeleted": 2,
"createdAt": "2024-02-28T19:17:21.469Z",
"updatedAt": "2024-02-28T19:17:21.469Z",
"attendanceTypeCategoryID": 1,
"contactFormID": 1,
"documentGroupID": 5,
"allowSchedule": 1,
"color": "#375ABB",
"price": null,
"limitDatesGenerateGrid": null,
"minimalTimeToAppointment": null,
"serviceTime": null,
"attendanceTime": null,
"accountID": 1,
"attendanceDocumentFormID": null
},
{
"ID": 150,
"name": "Test adauto 0703",
"isActive": 1,
"isDeleted": 2,
"createdAt": "2024-03-07T19:22:53.565Z",
"updatedAt": "2024-03-07T19:22:53.565Z",
"attendanceTypeCategoryID": 1,
"contactFormID": null,
"documentGroupID": null,
"allowSchedule": 1,
"color": "#375ABB",
"price": null,
"limitDatesGenerateGrid": null,
"minimalTimeToAppointment": null,
"serviceTime": null,
"attendanceTime": null,
"accountID": 1,
"attendanceDocumentFormID": null
},
{
"ID": 173,
"name": "Specialized Service",
"isActive": 1,
"isDeleted": 2,
"createdAt": "2024-11-21T17:40:59.129Z",
"updatedAt": "2024-11-21T17:43:24.072Z",
"attendanceTypeCategoryID": 1,
"contactFormID": 30,
"documentGroupID": 9,
"allowSchedule": 1,
"color": "#375ABB",
"price": null,
"limitDatesGenerateGrid": null,
"minimalTimeToAppointment": null,
"serviceTime": null,
"attendanceTime": null,
"accountID": 1,
"attendanceDocumentFormID": null
},
{
"ID": 180,
"name": "Test adauto 040225",
"isActive": 1,
"isDeleted": 2,
"createdAt": "2025-02-04T19:51:12.014Z",
"updatedAt": "2025-02-04T19:51:12.014Z",
"attendanceTypeCategoryID": 1,
"contactFormID": 31,
"documentGroupID": 5,
"allowSchedule": 1,
"color": "#375ABB",
"price": null,
"limitDatesGenerateGrid": null,
"minimalTimeToAppointment": null,
"serviceTime": null,
"attendanceTime": null,
"accountID": 1,
"attendanceDocumentFormID": null
},
{
"ID": 183,
"name": "test sergio 4",
"isActive": 1,
"isDeleted": 2,
"createdAt": "2025-03-19T22:08:47.860Z",
"updatedAt": "2025-03-19T22:08:47.860Z",
"attendanceTypeCategoryID": 1,
"contactFormID": 42,
"documentGroupID": 5,
"allowSchedule": 1,
"color": "#375ABB",
"price": null,
"limitDatesGenerateGrid": null,
"minimalTimeToAppointment": null,
"serviceTime": null,
"attendanceTime": null,
"accountID": 1,
"attendanceDocumentFormID": null
},
{
"ID": 184,
"name": "TEST FORM ID",
"isActive": 1,
"isDeleted": 2,
"createdAt": "2025-03-19T22:11:42.467Z",
"updatedAt": "2025-03-19T22:11:42.467Z",
"attendanceTypeCategoryID": 1,
"contactFormID": 31,
"documentGroupID": 5,
"allowSchedule": 1,
"color": "#375ABB",
"price": null,
"limitDatesGenerateGrid": null,
"minimalTimeToAppointment": null,
"serviceTime": null,
"attendanceTime": null,
"accountID": 1,
"attendanceDocumentFormID": null
},
{
"ID": 185,
"name": "test create with additional data sergio",
"isActive": 1,
"isDeleted": 2,
"createdAt": "2025-03-26T02:01:01.979Z",
"updatedAt": "2025-03-26T02:08:14.310Z",
"attendanceTypeCategoryID": 1,
"contactFormID": null,
"documentGroupID": null,
"allowSchedule": 1,
"color": "#375ABB",
"price": null,
"limitDatesGenerateGrid": null,
"minimalTimeToAppointment": null,
"serviceTime": null,
"attendanceTime": null,
"accountID": 1,
"attendanceDocumentFormID": null
},
{
"ID": 188,
"name": "creating without additional info",
"isActive": 1,
"isDeleted": 2,
"createdAt": "2025-03-26T02:12:18.348Z",
"updatedAt": "2025-03-26T02:12:18.348Z",
"attendanceTypeCategoryID": 1,
"contactFormID": null,
"documentGroupID": null,
"allowSchedule": 1,
"color": "#375ABB",
"price": null,
"limitDatesGenerateGrid": null,
"minimalTimeToAppointment": null,
"serviceTime": null,
"attendanceTime": null,
"accountID": 1,
"attendanceDocumentFormID": null
}
],
"error": null
}
```
{% endcode %}
#### Post List Regions for Scheduling
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/pa/listRegionsForAppointment
```
{% endcode %}
**Description:**\
Returns the list of **regions available for scheduling**, based on the provided attendance types.\
This endpoint is used after selecting the **attendance type**, to identify **where** it can be performed.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://api.tatodesk.com/pa/listRegionsForAppointment' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
"attendanceTypes": [1]
}
'
```
{% endcode %}
**Response Example:**
{% code lineNumbers="true" %}
```json
{
"regions": [
{
"ID": 53,
"name": "Paulista"
},
{
"ID": 57,
"name": "Belo Horizonte"
},
{
"ID": 62,
"name": "Proto Alegre"
}
],
"error": null
}
```
{% endcode %}
#### Post List Service Units for Scheduling
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/pa/listAttendanceUnitsForAppointment
```
{% endcode %}
**Description:**\
Returns the list of **attendance units available** for a given attendance type and region.\
This endpoint is used after selecting the **region**, allowing the user to choose **where** where the attendance will be performed.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://api.tatodesk.com/pa/listAttendanceUnitsForAppointment' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
"attendanceTypes": [1],
"regionID": 53
}'
```
{% endcode %}
**Response Example:**
{% code lineNumbers="true" %}
```json
{
"attendanceUnits": [
{
"ID": 288,
"name": "Unidade Central Limoeiro",
"address": "Rua C Bairro João Ernesto"
}
],
"error": null
}
```
{% endcode %}
#### Post List Dates for Scheduling
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/pa/listDates
```
{% endcode %}
**Description:**\
Returns the list of **available dates** to make the appointment at a specific unit and attendance type.
**Request Example**
{% code lineNumbers="true" %}
```json
curl --location 'https://api.tatodesk.com/pa/listDates' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
"companyID": 1,
"attendanceUnitID": 288,
"attendanceTypeIDs": [1]
}'
```
{% endcode %}
**Response Example**
{% code lineNumbers="true" %}
```json
{
"dates": [
"25/06/2025",
"26/06/2025",
"27/06/2025",
"30/06/2025",
"01/07/2025",
"02/07/2025",
"03/07/2025"
],
"error": null
}
```
{% endcode %}
#### Post List Periods for Scheduling
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/pa/listPeriods
```
{% endcode %}
**Description:**\
Returns the **available periods** (e.g.: morning, afternoon, evening) for scheduling on a specific date, unit and attendance type.
**Request Example**
{% code lineNumbers="true" %}
```json
curl --location 'https://api.tatodesk.com/pa/listPeriods' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
"companyID": 1,
"attendanceUnitID": 288,
"attendanceTypeIDs": [1],
"date": "25/06/2025"
}'
```
{% endcode %}
**Example Response**
{% code lineNumbers="true" %}
```json
{
"periods": [
{
"ID": 2,
"name": "Afternoon",
"createdAt": "2022-02-17T12:00:59.948Z",
"updatedAt": "2022-02-17T12:00:59.948Z"
},
{
"ID": 3,
"name": "Night",
"createdAt": "2022-03-12T00:23:20.475Z",
"updatedAt": "2022-03-12T00:23:20.475Z"
}
],
"error": null
}
```
{% endcode %}
#### Post List Hours for Appointment
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/pa/listHours
```
{% endcode %}
**Description:**\
Returns the **list of available times** within a given **period** (morning, afternoon, evening) for scheduling.
**Request Example**
{% code lineNumbers="true" %}
```json
curl --location 'https://api.tatodesk.com/pa/listHours' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
"companyID": 1,
"attendanceUnitID": 288,
"attendanceTypeIDs": [1],
"date": "25/06/2025",
"period": 2
}'
```
{% endcode %}
**Response Example**
{% code lineNumbers="true" %}
```json
{
"hours": [
"15:35",
"15:40",
"15:45",
"15:50",
"15:55",
"16:00",
"16:05",
"16:10",
"16:15",
"16:20",
"16:25",
"16:30",
"16:35",
"16:40",
"16:45",
"16:50",
"16:55",
"17:00",
"17:05",
"17:10",
"17:15",
"17:20",
"17:25",
"17:30",
"17:35",
"17:40",
"17:45",
"17:50",
"17:55"
],
"error": null
}
```
{% endcode %}
#### Post Create Appointment
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/pa/createAppointment
```
{% endcode %}
**Description:**\
Creates a **new appointment** in the Tatodesk system, based on the selected company, unit, type and date information.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://api.tatodesk.com/pa/createAppointment' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
"companyID": 1,
"attendanceUnitID": 288,
"categoryID": 1,
"attendanceTypes": [1],
"date": "25/06/2025",
"periodID": 2,
"hour": "15:40",
"channelID": 1,
"contactForms": [{
"key": "NAME",
"value": "Joãozinho"
}]
}'
```
{% endcode %}
**Response Example:**
{% code lineNumbers="true" %}
```json
{
"ID": 10238,
"protocol": "20250625153656345",
"documents": [
"Photo identification document",
"Proof of residence"
],
"error": null
}
```
{% endcode %}
#### Post Query Appointment
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/pa/getAppointment
```
{% endcode %}
**Description:**\
Retrieves the **complete details of an appointment** already created, using the **attendance protocol** returned at the time of creation.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://api.tatodesk.com/pa/getAppointment' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
"protocol": "20250625153656345"
}'
```
{% endcode %}
**Example Response:**
{% code lineNumbers="true" %}
```json
{
"appointment": {
"ID": 10238,
"protocol": "20250625153656345",
"company": "Tatodesk",
"attendanceType": "Debt Installment",
"attendanceUnitID": 288,
"attendanceUnit": "Unidade Central Limoeiro",
"attendanceUnitAddress": "Rua C Bairro João Ernesto",
"date": "2025-06-25",
"hour": "15:40:00",
"nick": "tato",
"profileID": 20,
"statusID": 5,
"status": "CANC. NO-SHOW",
"guiche": "Counter 1",
"documents": null,
"userID": null,
"userName": null,
"additionalDatas": [],
"contactForms": [
{
"ID": 33911,
"key": "NAME",
"value": "Joãozinho",
"keyTypeID": 1
}
]
},
"error": null
}
```
{% endcode %}
#### Post Get In-Person Service
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/pa/getPresentialAttendance
```
{% endcode %}
**Description:**\
Retrieves **detailed information** about an in-person attendance performed or scheduled, from the **attendance ID**.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://api.tatodesk.com/pa/getPresentialAttendance' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
"ID": 2361485
}'
```
{% endcode %}
**Example Response:**
{% code lineNumbers="true" %}
```json
{
"presentialAttendance": {
"ID": 2361485,
"protocol": "20250711161330715",
"date": "11/07/2025 16:13:30",
"sequence": 12,
"companyID": 1,
"companyName": "Tatodesk",
"statusName": "CANCELED NO-SHOW",
"statusID": 6,
"allowServiceDelay": 2,
"attendanceUnitID": 288,
"attendanceUnitName": "Unidade Central Limoeiro",
"attendanceClassificationID": 1,
"attendanceClassificationName": "Common",
"attendanceClassificationAbbreviation": "CM",
"pipelineStepName": null,
"userID": 25,
"userName": "Victor Ferreira",
"waitingTime": "00:00:09",
"attendanceTime": "",
"attendanceSequentialCode": "Counter 1",
"attendanceCode": "CM12",
"ticketNumber": "CM12",
"lastTramitDate": "11/07/2025 16:13",
"accountID": 1
},
"attendanceLinks": {
"rateLink": "https://arate.tatodesk.com/fb?p=20250711161330715&plt=pa&a=1",
"documentSubmissionLinks": [
{
"name": "Remote Support via Chat",
"formName": "Tadeu Copel",
"link": "https://attendance-document.tatodesk.com/ds?p=20250711161330715&plt=pa&atdfid=8dac9611-eea7-4507-bb82-e046ebbec1e0"
}
]
},
"error": null
}
```
{% endcode %}
#### Post Add Attachments
{% code lineNumbers="true" %}
```typescript
https://api-v2.tatodesk.com/pa/createAttachments
```
{% endcode %}
**Description:**\
Allows **associating attachments** (files) to an existing attendance, using the **appointment protocol**.\
The attachments are sent through **pre-stored URLs** on Tatodesk's server.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://api-v2.tatodesk.com/pa/createAttachments' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
"protocol": "20250917095431787",
"urls": ["https://message-file.tatodesk.net/file?fileID=74ea87fd-7dc5-41bc-a071-ac85726ad9da"]
}'
```
{% endcode %}
**Response Example:**
{% code lineNumbers="true" %}
```json
{
"error": null
}
```
{% endcode %}
## Marketing
#### Post Send notifications via Email
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/dl/v1/email/messages
```
{% endcode %}
**Description:**\
Allows **send notifications by email** using a **template configured in Tatodesk**.\
Supports sending attachments and dynamic parameters inside the message body.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://api.tatodesk.com/dl/v1/email/messages' \
--data-raw '{
"appID": "",
"templateID": "",
"email": {
"type": "template",
"to": "email.client@domain.com",
"templatePayload": {
"body": {
"params": [""],
"attachments":[{ "filename": "exemple.txt", "base64": "base64" }]
}
}
}
}'
```
{% endcode %}
## WhatsApp
#### Post Add Attachments
{% code lineNumbers="true" %}
```typescript
https://media-api.tatodesk.com/dl/v1/whatsapp/media
```
{% endcode %}
**Description:**\
Performs the **upload of media files** (images, audios, videos, documents etc.) to the **WhatsApp server via Tatodesk**, generating a **mediaID** that can be used later when sending messages.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://media-api.tatodesk.com/dl/v1/whatsapp/media' \
--header 'TATODESK-API-KEY: 0be4ebdc-6042-4042-8b48-374c07ec26c4' \
--form 'media=@"/C:/Users/consenso/Desktop/IMGS/logo_tatodesk.jpg"' \
--form 'appID="b23cbcd0-f2c3-4f8b-bb54-68a2e9197cdc"'
```
{% endcode %}
**Response Example:**
{% code lineNumbers="true" %}
```json
{
"media": {
"mediaID": "1051023410284838"
},
"error": null
}
```
{% endcode %}
#### Post Send Notification via WhatsApp
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/dl/v1/whatsapp/messages
```
{% endcode %}
**Description:**\
Sends a **template message via WhatsApp** to a specific number, using a model previously approved by the **WhatsApp Business API**.\
Allows including **images, dynamic parameters** and **metadata** for campaign tracking.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://api.tatodesk.com/dl/v1/whatsapp/messages' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
"appID": ,
"templateID": {{templateID}},
"whatsapp": {
"type": "template",
"to": "5581999998888",
"templatePayload": {
"header": {
"params": [
{
"type": "image",
"image": {
"link": "https://tatodesk.consensotec.com.br/dist/assets/img/logo_tatodesk.jpg"
}
}
]
},
"body": {
"params": [
{
"type": "TEXT",
"text": "Roberto"
},
{
"type": "TEXT",
"text": "30/07/2024"
}
]
}
}
},
"webhookID": "123",
"metadatas": {
"CAMPAIGN": "test-123"
}
}
'
```
{% endcode %}
#### Post Send Notification via WhatsApp - Using Media Upload
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/dl/v1/whatsapp/messages
```
{% endcode %}
**Description:**\
Upload a file to the ***'media upload' service*** and, in case of success (status code 200), receive a UUID in the response. Use this UUID in the "id" field inside `templatePayload -> header`, as illustrated in the example below.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://api.tatodesk.com/dl/v1/whatsapp/messages' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
"appID": ,
"templateID": {{templateID}},
"whatsapp": {
"type": "template",
"to": "5581999998888",
"templatePayload": {
"header": {
"params": [
{
"type": "image",
"image": {
"id": "8c2bb4c0-819c-4ca6-a6e4-a809f2849933"
}
}
]
},
"body": {
"params": [
{
"type": "TEXT",
"text": "Roberto"
},
{
"type": "TEXT",
"text": "30/07/2024"
}
]
}
}
},
"webhookID": "123",
"metadatas": {
"CAMPAIGN": "test-123"
}
}
'
```
{% endcode %}
## SMS
#### Post Send notification via SMS
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/dl/v1/sms/messages
```
{% endcode %}
**Description:**\
Allows the **sending of SMS messages based on templates**, using dynamic parameters and custom metadata. Ideal for automatic notifications, reminders and campaigns.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://api.tatodesk.com/dl/v1/sms/messages' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
"appID": ,
"templateID": {{templateID}},
"sms": {
"type": "template",
"to": "5581999998888",
"template": {
"params": ["Robeto", "01/28/2024"]
}
},
"webhookID": "123",
"metadatas": {
"CAMPAIGN": "test-123"
}
}'
```
{% endcode %}
## Data API
#### Post Digital Services Report
{% code lineNumbers="true" %}
```typescript
https://data.tatodesk.com/cc/listAttendancesReport
```
{% endcode %}
**API to list digital attendances:**
* **filter (required)** object with the query filter
* **dateInitial (required)** initial date in the format **DD/MM/YYYY**.
* **dateFinal (required)** final date in the format **DD/MM/YYYY.**
* **protocol (optional)** text with the attendance protocol.
* **sessionID (optional)** text with the attendance session.
* **statusIDs (optional)** list of numeric values
* **departmentIDs (optional)** list of numeric values
* **userIDs (optional)** list of numeric values
* **tagIDs (optional)** list of numeric values
* **channelIDs (optional)** list of numeric values
* **rates (optional)** list of numeric values
* **sentiments (optional)** list of numeric values
* **attendanceTime (optional)** object to select attendances by attendance time:
* **operation (required)** numeric value with the operation.\
1 - Less\
2 - Less or equal\
3 - Greater\
4 - Greater or equal\
5 - Between
* **value (required)** numeric value in minutes.
* **valueFinal (required when the operation value is 5)** numeric value in minutes.
* **waitingTime (optional)** object to select attendances by waiting time
* **operation (required)** numeric value with the operation.\
1 - Less\
2 - Less or equal\
3 - Greater\
4 - Greater or equal\
5 - Between
* **value (required)** numeric value in minutes.
* **valueFinal (required when the operation value is 5)** numeric value in minutes.
* **firstAgentReply (optional)** object to select attendances by the time of the first agent reply:
* **operation (required)** numeric value with the operation.\
1 - Less\
2 - Less or equal\
3 - Greater\
4 - Greater or equal\
5 - Between
* **value (required)** numeric value in minutes.
* **valueFinal (required when the operation value is 5)** numeric value in minutes.
* **timeAgentClientReply (optional)** object to select attendances by the time of the agent's reply to the client
* **operation (required)** numeric value with the operation.\
1 - Less\
2 - Less or equal\
3 - Greater\
4 - Greater or equal\
5 - Between
* **value (required)** numeric value in minutes.
* **valueFinal (required when the operation value is 5)** numeric value in minutes.
* **timeClientAgentReply (optional)** object to select attendances by the time of the client's reply to the agent
* **operation (required)** numeric value with the operation.\
1 - Less\
2 - Less or equal\
3 - Greater\
4 - Greater or equal\
5 - Between
* **value (required)** numeric value in minutes.
* **valueFinal (required when the operation value is 5)** numeric value in minutes.
* **form (optional)** object to select attendances by form:
* **key (required)** text with the form key
* **value (required)** text with the form value
* **additionalData (optional)** object to select attendances by additional data
* **ID (required)** text with the identifier of the additional information
* **value (required)** text with the value of the additional information
* **page (required)** positive numeric value (values starting from 0) that represents the query page.
* **limit (optional)** positive numeric value (values starting from 1) that represents the number of records in each query; if not provided the default value is 1000.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://data.tatodesk.com/cc/listAttendancesReport' \
--header 'TATODESK-API-KEY: {{API-KEY-REPORT}}' \
--data '{
"filter": {
"dateInitial": "01/01/2024",
"dateFinal": "30/01/2025",
"protocol": "",
"sessionID": "",
"statusIDs": [],
"departmentIDs": [],
"userIDs": [],
"tagIDs": [],
"channelIDs": [],
"rates": [],
"sentiments": [],
"attendanceTime": {
"operation": 1,
"value": 1,
"valueFinal": 1
}
},
"page": 0,
"limit": 10
}'
```
{% endcode %}
**Response Example:**
{% code lineNumbers="true" %}
```json
{
"count": "66",
"attendances": [
{
"ID": 3495525,
"protocol": "20241211133413753",
"session": "9a2221e7-93ef-411f-9266-da0b1d8e6028",
"date": "2024-12-11T13:34:13.753Z",
"status": "Completed",
"channel": "WhatsApp",
"department": "Support N1",
"userName": "Tadeu Support",
"rate": "Excellent",
"attendanceTime": "00:00:06",
"waitingTime": "00:00:11",
"firstAgentReply": "",
"timeClientAgentReply": "",
"timeAgentClientReply": "",
"sentiment": null,
"metadatas": "NAME:Tadeu | EMAIL:tadeu@gmail.com | PHONE:558199998888",
"additionalData": null
},
{
"ID": 3481079,
"protocol": "20241209105656686",
"session": "fade4dc6-3dd6-4979-a4f5-afe62b95a5ab",
"date": "2024-12-09T10:56:56.686Z",
"status": "Completed",
"channel": "Webchat",
"department": "Support N1",
"userName": "Tatodesk Support",
"rate": "Excellent",
"attendanceTime": "00:00:19",
"waitingTime": "00:00:11",
"firstAgentReply": "00:00:07",
"timeClientAgentReply": "",
"timeAgentClientReply": "00:00:05",
"sentiment": null,
"metadatas": "NAME:Moises | EMAIL:moises@email.com | PHONE:8188889999",
"additionalData": null
},
{
"ID": 3413027,
"protocol": "20241122141630976",
"session": "960ac15b-2c71-4e69-99a1-de0a8f7c595c",
"date": "2024-11-22T14:16:30.976Z",
"status": "Completed",
"channel": "WhatsApp",
"department": "Support N1",
"userName": "Tadeu Support",
"rate": "Very bad",
"attendanceTime": "00:00:06",
"waitingTime": "00:00:14",
"firstAgentReply": "",
"timeClientAgentReply": "",
"timeAgentClientReply": "",
"sentiment": null,
"metadatas": "NAME:Tadeu | EMAIL:tadeu@email.com | PHONE:558199998888",
"additionalData": "WHATSAPP_NUMBER:558199998888"
},
{
"ID": 3412676,
"protocol": "20241122133039349",
"session": "8021e542-daf0-49a6-a644-d6e9c9582905",
"date": "2024-11-22T13:30:39.349Z",
"status": "Completed",
"channel": "WhatsApp",
"department": "Support N1",
"userName": "Tadeu Support",
"rate": "Excellent",
"attendanceTime": "00:00:07",
"waitingTime": "00:16:33",
"firstAgentReply": "",
"timeClientAgentReply": "",
"timeAgentClientReply": "",
"sentiment": null,
"metadatas": "NAME:Tadeu | EMAIL:tadeu@email.com | PHONE:558199998888",
"additionalData": "WHATSAPP_NUMBER:558199998888"
},
{
"ID": 3336861,
"protocol": "20241105110228168",
"session": "07c1d585-5c78-42de-9fc0-9fd22fdb425c",
"date": "2024-11-05T11:02:28.168Z",
"status": "Completed",
"channel": "WhatsApp",
"department": "Support N1",
"userName": "Tadeu Support",
"rate": "Excellent",
"attendanceTime": "00:00:20",
"waitingTime": "00:00:15",
"firstAgentReply": "00:00:06",
"timeClientAgentReply": "",
"timeAgentClientReply": "00:00:06",
"sentiment": null,
"metadatas": "NAME:Tadeu | EMAIL:tadeu@email.com | PHONE:558199998888",
"additionalData": "WHATSAPP_NUMBER:558199998888"
},
{
"ID": 3322636,
"protocol": "20241101114624894",
"session": "5e6ddb3c-57e9-4e17-a352-7500ed118cad",
"date": "2024-11-01T11:46:24.894Z",
"status": "Completed",
"channel": "WhatsApp",
"department": "Support N1",
"userName": "Tatodesk Support",
"rate": null,
"attendanceTime": "00:00:57",
"waitingTime": "00:00:14",
"firstAgentReply": "00:00:19",
"timeClientAgentReply": "",
"timeAgentClientReply": "",
"sentiment": null,
"metadatas": "NAME:Moises | EMAIL:moises@email.com | PHONE:558198888999",
"additionalData": "WHATSAPP_NUMBER:558198888999"
},
{
"ID": 3300296,
"protocol": "20241028145931622",
"session": "8706b28f-cf1e-4841-9aea-ce6a5581a0b1",
"date": "2024-10-28T14:59:31.622Z",
"status": "Completed",
"channel": "WhatsApp",
"department": "Support N1",
"userName": "Tadeu Support",
"rate": "Excellent",
"attendanceTime": "00:00:55",
"waitingTime": "00:00:08",
"firstAgentReply": "",
"timeClientAgentReply": "",
"timeAgentClientReply": "00:00:31",
"sentiment": null,
"metadatas": "NAME:Tadeu | EMAIL:tadeu@email.com | PHONE:558199998888",
"additionalData": "WHATSAPP_NUMBER:558199998888"
},
{
"ID": 3299950,
"protocol": "20241028140848305",
"session": "769bf318-40a8-4834-98f2-d7a799c63602",
"date": "2024-10-28T14:08:48.305Z",
"status": "Completed",
"channel": "WhatsApp",
"department": "Support N1",
"userName": "Tadeu Support",
"rate": null,
"attendanceTime": "00:00:13",
"waitingTime": "00:01:00",
"firstAgentReply": "",
"timeClientAgentReply": "",
"timeAgentClientReply": "",
"sentiment": null,
"metadatas": "NAME:Tadeu | EMAIL:tsarmento@yahoo.com | PHONE:558199998888",
"additionalData": "WHATSAPP_NUMBER:558199998888"
},
{
"ID": 3242326,
"protocol": "20241015093248120",
"session": "97d3235f-03a3-4d8c-8515-d62af0b385c1",
"date": "2024-10-15T09:32:48.120Z",
"status": "Completed",
"channel": "Webchat",
"department": "Support N1",
"userName": "Tadeu Support",
"rate": null,
"attendanceTime": "00:00:31",
"waitingTime": "00:00:08",
"firstAgentReply": "",
"timeClientAgentReply": "00:00:03",
"timeAgentClientReply": "",
"sentiment": 1,
"metadatas": "NAME:Tadei Test | EMAIL:tadeu@email.com | PHONE:03136537816",
"additionalData": null
},
{
"ID": 3211755,
"protocol": "20241008081401928",
"session": "01a7c700-0213-4ffe-8bc7-9250bb45c036",
"date": "2024-10-08T08:14:01.928Z",
"status": "Client does not respond",
"channel": "Webchat",
"department": "Support N1",
"userName": "Tadeu Support",
"rate": null,
"attendanceTime": "",
"waitingTime": "00:27:50",
"firstAgentReply": "",
"timeClientAgentReply": "",
"timeAgentClientReply": "",
"sentiment": 2,
"metadatas": "NAME:Pablo | EMAIL:pablo@gmail.com | PHONE:44991613335",
"additionalData": null
}
],
"error": null
}
```
{% endcode %}
#### Post Campaigns Report
{% code lineNumbers="true" %}
```typescript
https://data.tatodesk.com/mkt/listCampaignsReport
```
{% endcode %}
**API to list campaign information:**
* **filter (required)** object with the query filter
* dateInitial (required) initial date in the format **DD/MM/YYYY.**
* **dateFinal (required)** final date in the format **DD/MM/YYYY.**
* **archived (optional)** numeric value indicating whether the campaign is archived or not.
* 1 - Yes
* 2 - No
* **departmentIDs (optional)** list of numeric values
* **page (required)** positive numeric value (values starting from 0) that represents the query page.
* **limit (optional)** positive numeric value (values starting from 1) that represents the number of records in each query; if not provided the default value is 100000.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://data.tatodesk.com/mkt/listCampaignsReport' \
--header 'TATODESK-API-KEY: 6954e347-be4b-4cfc-94f3-b9f0f9f1713a' \
--data '{
"filter": {
"dateInitial": "01/01/2024",
"dateFinal": "30/06/2025"
},
"page": 0,
"limit": 10
}'
```
{% endcode %}
**Response Example:**
{% code lineNumbers="true" %}
```json
{
"count": "15",
"campaignItems": [
{
"campaignID": 1003392,
"targetAudienceID": 25696020,
"name": "campanha_teste_sefin",
"campaignType": "whatsapp",
"department": null,
"template": "tmpl_grp_tematico_2",
"date": "2024-08-27T17:03:00.000Z",
"campaignStatus": "Finished",
"targetAudience": "grupo_sefin",
"targetAudienceType": "Phone",
"key": "5581988887777",
"status": "Completed",
"parameters": "SEFIN",
"error": null,
"interaction": "No",
"user": "Presentation Support",
"sessionID": null,
"read": "No",
"delivered": "Yes",
"whatsappBillable": null,
"whatsappPricingModel": null,
"whatsappCategory": null,
"conversion": null
},
{
"campaignID": 1003392,
"targetAudienceID": 25696021,
"name": "campanha_teste_sefin",
"campaignType": "whatsapp",
"department": null,
"template": "tmpl_grp_tematico_2",
"date": "2024-08-27T17:03:00.000Z",
"campaignStatus": "Finished",
"targetAudience": "grupo_sefin",
"targetAudienceType": "Phone",
"key": "5581988887777",
"status": "Completed",
"parameters": "SEFIN",
"error": null,
"interaction": "No",
"user": "Presentation Support",
"sessionID": null,
"read": "No",
"delivered": "Yes",
"whatsappBillable": null,
"whatsappPricingModel": null,
"whatsappCategory": null,
"conversion": null
},
{
"campaignID": 1004873,
"targetAudienceID": 28296433,
"name": "presentation campaign model 01",
"campaignType": "whatsapp",
"department": null,
"template": null,
"date": "2024-11-21T16:38:00.000Z",
"campaignStatus": "Finished",
"targetAudience": "pa-presentation campaign model 01",
"targetAudienceType": "Phone",
"key": "5581988887777",
"status": "Completed",
"parameters": "new call",
"error": null,
"interaction": "No",
"user": "Presentation Support",
"sessionID": null,
"read": "No",
"delivered": "Yes",
"whatsappBillable": null,
"whatsappPricingModel": null,
"whatsappCategory": null,
"conversion": null
},
{
"campaignID": 1005199,
"targetAudienceID": 28644547,
"name": "test_otp",
"campaignType": "whatsapp",
"department": null,
"template": "test_otp",
"date": "2024-12-04T13:55:00.000Z",
"campaignStatus": "Error",
"targetAudience": "pa-test_otp",
"targetAudienceType": "Phone",
"key": "5581988887777",
"status": "Error",
"parameters": "4321",
"error": "(#131008) Required parameter is missing. buttons: Button at index 0 of type Url requires a parameter",
"interaction": "No",
"user": "Presentation Support",
"sessionID": null,
"read": "No",
"delivered": "No",
"whatsappBillable": null,
"whatsappPricingModel": null,
"whatsappCategory": null,
"conversion": null
},
{
"campaignID": 1005199,
"targetAudienceID": 28644548,
"name": "test_otp",
"campaignType": "whatsapp",
"department": null,
"template": "test_otp",
"date": "2024-12-04T13:55:00.000Z",
"campaignStatus": "Error",
"targetAudience": "pa-test_otp",
"targetAudienceType": "Phone",
"key": "5581988887777",
"status": "Error",
"parameters": "1234",
"error": "(#131008) Required parameter is missing. buttons: Button at index 0 of type Url requires a parameter",
"interaction": "No",
"user": "Presentation Support",
"sessionID": null,
"read": "No",
"delivered": "No",
"whatsappBillable": null,
"whatsappPricingModel": null,
"whatsappCategory": null,
"conversion": null
},
{
"campaignID": 1008327,
"targetAudienceID": 30287359,
"name": "Metadata test campaign",
"campaignType": "whatsapp",
"department": null,
"template": "complete_template_model",
"date": "2025-04-10T10:19:00.000Z",
"campaignStatus": "Finished",
"targetAudience": "pa-Metadata test campaign",
"targetAudienceType": "Phone",
"key": "5581988887777",
"status": "Completed",
"parameters": "roberto",
"error": null,
"interaction": "Yes",
"user": "Presentation Support",
"sessionID": "8f2130a7-567e-4a09-9979-232a375d68f8",
"read": "No",
"delivered": "Yes",
"whatsappBillable": null,
"whatsappPricingModel": null,
"whatsappCategory": null,
"conversion": null
},
{
"campaignID": 1008328,
"targetAudienceID": 30287360,
"name": "Template campaign for metro - using target audience",
"campaignType": "whatsapp",
"department": null,
"template": "complete_template_model",
"date": "2025-04-10T10:25:00.000Z",
"campaignStatus": "Finished",
"targetAudience": "template for complete template - metro",
"targetAudienceType": "Phone",
"key": "5581988887777",
"status": "Completed",
"parameters": "roberto",
"error": null,
"interaction": "Yes",
"user": "Presentation Support",
"sessionID": "8f2130a7-567e-4a09-9979-232a375d68f8",
"read": "No",
"delivered": "Yes",
"whatsappBillable": null,
"whatsappPricingModel": null,
"whatsappCategory": null,
"conversion": null
},
{
"campaignID": 1008356,
"targetAudienceID": 30290289,
"name": "Test campaign without parameters",
"campaignType": "whatsapp",
"department": null,
"template": "line_break_test_template",
"date": "2025-04-10T16:05:00.000Z",
"campaignStatus": "Finished",
"targetAudience": "pa-Test campaign without parameters",
"targetAudienceType": "Phone",
"key": "5581988887777",
"status": "Completed",
"parameters": null,
"error": null,
"interaction": "No",
"user": "Presentation Support",
"sessionID": null,
"read": "No",
"delivered": "Yes",
"whatsappBillable": null,
"whatsappPricingModel": null,
"whatsappCategory": null,
"conversion": null
},
{
"campaignID": 1008371,
"targetAudienceID": 30296302,
"name": "Presentation",
"campaignType": "whatsapp",
"department": null,
"template": "complete_template_model",
"date": "2025-04-11T10:27:00.000Z",
"campaignStatus": "Error",
"targetAudience": "pa-Presentation",
"targetAudienceType": "Phone",
"key": "5581988887777",
"status": "Error",
"parameters": null,
"error": "(#132000) Number of parameters does not match the expected number of params. body: number of localizable_params (0) does not match the expected number of params (1)",
"interaction": "No",
"user": "Presentation Support",
"sessionID": null,
"read": "No",
"delivered": "No",
"whatsappBillable": null,
"whatsappPricingModel": null,
"whatsappCategory": null,
"conversion": null
},
{
"campaignID": 1008802,
"targetAudienceID": 30500291,
"name": "Presentation Test 01 - 05052025",
"campaignType": "whatsapp",
"department": null,
"template": "presentation_tatodesk",
"date": "2025-05-05T15:35:00.000Z",
"campaignStatus": "Finished",
"targetAudience": "pa-Presentation Test 01 - 05052025",
"targetAudienceType": "Phone",
"key": "5581988887777",
"status": "Completed",
"parameters": "Roberto",
"error": null,
"interaction": "No",
"user": "Presentation Support",
"sessionID": null,
"read": "No",
"delivered": "Yes",
"whatsappBillable": 1,
"whatsappPricingModel": "CBP",
"whatsappCategory": "marketing",
"conversion": null
}
],
"error": null
}
```
{% endcode %}
#### POST In-Person Services Report
{% code lineNumbers="true" %}
```typescript
https://data.tatodesk.com/pa/listAttendancesReport
```
{% endcode %}
**API to list in-person attendances:**
* **filter (required)** object with the query filter:
* **dateInitial (required)** initial date in the format **DD/MM/YYYY.**
* **dateFinal (required)** final date in the format **DD/MM/YYYY.**
* **protocol (optional)** text with the attendance protocol.
* **attendanceCode (optional)** text with the attendance password.
* **companyIDs (optional)** list of numeric values
* **attendanceUnitIDs (optional)** list of numeric values
* **attendanceTypeIDs (optional)** list of numeric values
* **statusIDs (optional)** list of numeric values
* **userIDs (optional)** list of numeric values
* **tagIDs (optional)** list of numeric values
* **attendanceTime (optional)** object to select attendances by attendance duration
* **operation (required)** numeric value with the operation.\
1 - Less\
2 - Less or equal\
3 - Greater\
4 - Greater or equal\
5 - Between
* **value (required)** numeric value in minutes.
* **valueFinal (required when the operation value is 5)** numeric value in minutes.
* **waitingTime (optional)** object to select attendances by waiting time
* **operation (required)** numeric value with the operation.\
1 - Less\
2 - Less or equal\
3 - Greater\
4 - Greater or equal\
5 - Between
* **value (required)** numeric value in minutes.
* **valueFinal (required when the operation value is 5)** numeric value in minutes.
* **pausedTime (optional)** object to select attendances by agent's first response time
* **operation (required)** numeric value with the operation.\
1 - Less\
2 - Less or equal\
3 - Greater\
4 - Greater or equal\
5 - Between
* **value (required)** numeric value in minutes.
* **valueFinal (required when the operation value is 5)** numeric value in minutes.
* **form (optional)** object to select attendances by form:
* **key (required)** text with the form key
* **value (required)** text with the form value
* **additionalData (optional)** object to select attendances by additional data
* **ID (required)** text with the identifier of the additional information
* **value (required)** text with the value of the additional information
* **page (required)** positive numeric value (values starting from 0) that represents the query page.
* **limit (optional)** positive numeric value (values starting from 1) that represents the number of records in each query, if not informed the default value is 1000.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://data.tatodesk.com/pa/listAttendancesReport' \
--header 'TATODESK-API-KEY: {{DATA-API-PA}}' \
--data '{
"filter": {
"dateInitial": "01/01/2024",
"dateFinal": "30/01/2024",
"protocol": "",
"attendanceCode": "",
"companyIDs": [],
"attendanceUnitIDs": [],
"attendanceTypeIDs": [],
"statusIDs": [],
"userIDs": [],
"tagIDs": [],
"attendanceTime": {
"operation": 1,
"value": 1,
"valueFinal": 1
},
"waitingTime": {
"operation": 1,
"value": 1,
"valueFinal": 1
},
"pausedTime": {
"operation": 1,
"value": 1,
"valueFinal": 1
},
"form": {
"key": "",
"value": ""
},
"additionalData": {
"ID": "",
"value": ""
}
},
"page": 0,
"limit": 10
}'
```
{% endcode %}
**Response Example:**
{% code lineNumbers="true" %}
```json
{
"count": "25",
"attendances": [
{
"protocol": "20240122112732490",
"attendanceCode": "CM1",
"classification": "Common",
"status": "CANCELED NO-SHOW",
"company": "Tatodesk",
"region": "Greater Recife",
"attendanceUnit": "Recife Antigo Unit",
"attendanceType": "New others",
"ticketWindowType": "presential",
"agent": "Victor Ferreira",
"date": "2024-01-22T11:27:32.490Z",
"dateCall": "2024-01-22T11:28:19.257Z",
"startAttendance": null,
"waitingTime": "00:00:47",
"displacementTime": "",
"pausedTime": "",
"attendanceTime": "",
"remoteAttendance": "No",
"additionalData": null,
"contactForms": "NAME:José Emanuel"
},
{
"protocol": "20240119155943608",
"attendanceCode": "CM2",
"classification": "Common",
"status": "COMPLETED",
"company": "Tatodesk",
"region": "Greater Recife",
"attendanceUnit": "Recife Antigo Unit",
"attendanceType": "New others",
"ticketWindowType": "presential",
"agent": "Victor Ferreira",
"date": "2024-01-19T15:59:43.608Z",
"dateCall": "2024-01-19T16:00:36.736Z",
"startAttendance": "2024-01-19T16:00:58.156Z",
"waitingTime": "00:00:53",
"displacementTime": "",
"pausedTime": "",
"attendanceTime": "00:00:53",
"remoteAttendance": "No",
"additionalData": null,
"contactForms": "EMAIL:e.googl899@gmail.com | NAME:Jonathan"
},
{
"protocol": "20240117172536554",
"attendanceCode": "CM1",
"classification": "Common",
"status": "CANCELED DUE TO EXPIRATION",
"company": "Tatodesk 2",
"region": "Belo Horizonte",
"attendanceUnit": "Central Unit",
"attendanceType": "Debt Installment",
"ticketWindowType": null,
"agent": null,
"date": "2024-01-17T17:25:36.554Z",
"dateCall": null,
"startAttendance": null,
"waitingTime": "",
"displacementTime": "",
"pausedTime": "",
"attendanceTime": "",
"remoteAttendance": "No",
"additionalData": null,
"contactForms": "NAME:Moises"
},
{
"protocol": "20240117165737390",
"attendanceCode": "CM13",
"classification": "Common",
"status": "COMPLETED",
"company": "Tatodesk",
"region": "Greater Recife",
"attendanceUnit": "Recife Antigo Unit",
"attendanceType": "New others",
"ticketWindowType": null,
"agent": "Victor Ferreira",
"date": "2024-01-17T16:57:37.389Z",
"dateCall": null,
"startAttendance": "2024-01-17T16:57:54.607Z",
"waitingTime": "00:00:17",
"displacementTime": "",
"pausedTime": "",
"attendanceTime": "00:00:16",
"remoteAttendance": "No",
"additionalData": null,
"contactForms": "EMAIL:jonathan.marcos@tatodesk.com | NAME:Jonathan"
},
{
"protocol": "20240117152350617",
"attendanceCode": "CM6",
"classification": "Common",
"status": "CANCELED NO-SHOW",
"company": "Tatodesk",
"region": "Greater Recife",
"attendanceUnit": "Recife Antigo Unit",
"attendanceType": "New others",
"ticketWindowType": "presential",
"agent": "Victor Ferreira",
"date": "2024-01-17T15:23:50.617Z",
"dateCall": "2024-01-17T15:24:13.906Z",
"startAttendance": null,
"waitingTime": "00:00:23",
"displacementTime": "",
"pausedTime": "",
"attendanceTime": "",
"remoteAttendance": "No",
"additionalData": null,
"contactForms": "EMAIL:emanuelalbuquerque16@gmail.com | NAME:José Emanuel"
},
{
"protocol": "20240117135720803",
"attendanceCode": "CM1",
"classification": "Common",
"status": "CANCELED NO-SHOW",
"company": "Tatodesk",
"region": "Greater Recife",
"attendanceUnit": "Recife Antigo Unit",
"attendanceType": "New others",
"ticketWindowType": "presential",
"agent": "Victor Ferreira",
"date": "2024-01-17T13:57:20.803Z",
"dateCall": "2024-01-17T13:57:52.499Z",
"startAttendance": "2024-01-17T13:58:37.254Z",
"waitingTime": "00:00:32",
"displacementTime": "",
"pausedTime": "",
"attendanceTime": "",
"remoteAttendance": "No",
"additionalData": null,
"contactForms": "EMAIL:emanuelalbuquerque16@gmail.com | NAME:José Emanuel"
},
{
"protocol": "20240112113654903",
"attendanceCode": "CM1",
"classification": "Common",
"status": "COMPLETED",
"company": "Tatodesk",
"region": "Fortaleza",
"attendanceUnit": "Madalena Unit",
"attendanceType": "New others",
"ticketWindowType": "presential",
"agent": "Tadeu Copel",
"date": "2024-01-12T11:36:54.903Z",
"dateCall": "2024-01-12T11:52:42.610Z",
"startAttendance": "2024-01-12T11:52:47.822Z",
"waitingTime": "00:00:05",
"displacementTime": "",
"pausedTime": "",
"attendanceTime": "00:00:08",
"remoteAttendance": "No",
"additionalData": null,
"contactForms": "EMAIL:TADEU@gmail.com | NAME:TADEU | CPF_CNPJ:36742676086"
},
{
"protocol": "20240112102035479",
"attendanceCode": "CM1",
"classification": "Common",
"status": "CANCELED NO-SHOW",
"company": "Tatodesk",
"region": "Greater Recife",
"attendanceUnit": "Recife Antigo Unit",
"attendanceType": "New complaint",
"ticketWindowType": "presential",
"agent": "Victor Ferreira",
"date": "2024-01-12T10:20:35.479Z",
"dateCall": "2024-01-12T10:31:56.935Z",
"startAttendance": null,
"waitingTime": "",
"displacementTime": "",
"pausedTime": "",
"attendanceTime": "",
"remoteAttendance": "No",
"additionalData": null,
"contactForms": "NAME:AAAAA"
},
{
"protocol": "20240110233121306",
"attendanceCode": "CM5",
"classification": "Common",
"status": "CANCELED NO-SHOW",
"company": "Tatodesk",
"region": "Greater Recife",
"attendanceUnit": "Recife Antigo Unit",
"attendanceType": "New others",
"ticketWindowType": "presential",
"agent": "Victor Ferreira",
"date": "2024-01-10T23:31:21.306Z",
"dateCall": "2024-01-12T12:15:04.511Z",
"startAttendance": null,
"waitingTime": "",
"displacementTime": "",
"pausedTime": "",
"attendanceTime": "",
"remoteAttendance": "No",
"additionalData": null,
"contactForms": "EMAIL:emanuelalbuquerque16@gmail.com | NAME:José Emanuel | CPF_CNPJ:11382391439"
},
{
"protocol": "20240109224458346",
"attendanceCode": "CM6",
"classification": "Common",
"status": "CANCELED NO-SHOW",
"company": "Tatodesk",
"region": "Greater Recife",
"attendanceUnit": "Recife Antigo Unit",
"attendanceType": "New others",
"ticketWindowType": "presential",
"agent": "Victor Ferreira",
"date": "2024-01-09T22:44:58.346Z",
"dateCall": "2024-01-09T22:47:00.917Z",
"startAttendance": null,
"waitingTime": "",
"displacementTime": "",
"pausedTime": "",
"attendanceTime": "",
"remoteAttendance": "No",
"additionalData": null,
"contactForms": "EMAIL:emanuelalbuquerque16@gmail.com | NAME:José Emanuel | CPF_CNPJ:11382391439"
}
],
"error": null
}
```
{% endcode %}
#### POST Tickets Report
{% code lineNumbers="true" %}
```typescript
https://data.tatodesk.com/ticket/listTicketIssuesReport
```
{% endcode %}
**API to list tickets:**
* **filter (required)** object with the query filter:
* **dateInitial (required)** initial date in the format **DD/MM/YYYY**.
* **dateFinal (required)** final date in the format **DD/MM/YYYY**.
* **protocol (optional)** text with the attendance protocol.
* **statusIDs (optional)** list of numeric values
* **organizationIDs (optional)** list of numeric values
* **projectIDs (optional)** list of numeric values
* **departmentIDs (optional)** list of numeric values
* **userIDs (optional)** list of numeric values
* **form (optional)** object to select attendances by additional data
* **key (required)** text with the form key
* **value (required)** text with the form value
* **page (required)** positive numeric value (values starting from 0) that represents the query page.
* **limit (optional)** positive numeric value (values starting from 1) that represents the number of records in each query, if not informed the default value is 1000.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://data.tatodesk.com/ticket/listTicketIssuesReport' \
--header 'TATODESK-API-KEY: {{API-KEY-REPORT}}' \
--data '{
"filter": {
"dateInitial": "01/01/2025",
"dateFinal": "30/01/2025",
"protocol": "",
"statusIDs": [],
"organizationIDs": [],
"projectIDs": [],
"departmentIDs": [],
"userIDs": [],
"form": {
"key": "",
"value": ""
}
},
"page": 0,
"limit": 10
}'
```
{% endcode %}
**Response Example:**
{% code lineNumbers="true" %}
```json
{
"count": "8",
"attendances": [
{
"protocol": "20250129103237613",
"date": "2025-01-29T10:32:37.613Z",
"finishedDate": "2025-01-30T11:08:06.096Z",
"status": "Resolved",
"department": "Support",
"attendanceType": "Digital Attendance - General",
"origin": "e-mail",
"email": "roberto.lima@tatodesk.com",
"subject": "Re: Ticket Forwarding - 20250129102133224",
"user": "Tadeu Support",
"additionalData": null,
"threads": null
},
{
"protocol": "20250129102133224",
"date": "2025-01-29T10:21:33.224Z",
"finishedDate": "2025-01-30T11:08:22.589Z",
"status": "Resolved",
"department": "Improvement Suggestions",
"attendanceType": "Improvement Suggestions",
"origin": "tatodesk",
"email": "tadeu.sarmento@tatodesk.com",
"subject": "Your ticket has been created",
"user": "Tadeu Support",
"additionalData": null,
"threads": "SUBJECT:Ticket Forwarding - 20250129102133224#EMAILS:victor.ferreira@tatodesk.com, roberto.lima@tatodesk.com"
},
{
"protocol": "20250128162948396",
"date": "2025-01-28T16:29:48.396Z",
"finishedDate": "2025-02-09T17:32:00.208Z",
"status": "Resolved",
"department": "Improvement Suggestions",
"attendanceType": "Improvement Suggestions",
"origin": "tatodesk",
"email": "tadeu.sarmento@tatodesk.com",
"subject": "Your ticket has been created",
"user": "Tadeu Support",
"additionalData": null,
"threads": "SUBJECT:Ticket Forwarding - 20250128162948396#EMAILS:tadeu.sarmento@gmai.com, kamila.lima@tatodesk.com; roberto.lima@tatodesk.com | SUBJECT:Ticket Forwarding - 20250128162948396#EMAILS:tadeu.sarmento@gmail.com, kamila.lima@tatodesk.com, roberto.lima@tatodesk.com"
},
{
"protocol": "20250125101453943",
"date": "2025-01-25T10:14:53.943Z",
"finishedDate": "2025-01-27T09:08:01.233Z",
"status": "Resolved",
"department": "Support",
"attendanceType": "Digital Attendance - General",
"origin": "tatodesk",
"email": "laurencelamare@gmail.com",
"subject": "Your ticket has been created",
"user": "Tadeu Support",
"additionalData": null,
"threads": null
},
{
"protocol": "20250110180216211",
"date": "2025-01-10T18:02:16.211Z",
"finishedDate": null,
"status": "Waiting for Response",
"department": "Support",
"attendanceType": "Digital Attendance - General",
"origin": "tatodesk",
"email": "central.agendamento@crer.org.br",
"subject": "Your ticket has been created",
"user": "Kamila Support",
"additionalData": null,
"threads": null
},
{
"protocol": "20250110131737731",
"date": "2025-01-10T13:17:37.731Z",
"finishedDate": null,
"status": "Answered",
"department": "Support",
"attendanceType": "Digital Attendance - General",
"origin": "tatodesk",
"email": "carlos.lino@campinas.sp.gov.br",
"subject": "Your ticket has been created",
"user": "Kamila Support",
"additionalData": null,
"threads": null
},
{
"protocol": "20250108112623024",
"date": "2025-01-08T11:26:23.024Z",
"finishedDate": "2025-01-08T15:10:29.052Z",
"status": "Resolved",
"department": "Support",
"attendanceType": "Digital Attendance - General",
"origin": "tatodesk",
"email": "central.agendamento@crer.org.br",
"subject": "Your ticket has been created",
"user": "Kamila Support",
"additionalData": null,
"threads": null
},
{
"protocol": "20250106143710195",
"date": "2025-01-06T14:37:10.195Z",
"finishedDate": "2025-01-14T08:06:18.222Z",
"status": "Resolved",
"department": "Support",
"attendanceType": "Access Permissions",
"origin": "tatodesk",
"email": "kamila.lima@tatodesk.com",
"subject": "Your ticket has been created",
"user": "Kamila Support",
"additionalData": null,
"threads": null
}
],
"error": null
}
```
{% endcode %}
#### Post Search by protocol
{% code lineNumbers="true" %}
```typescript
https://data.tatodesk.com/global/searchProtocol
```
{% endcode %}
**Description:**\
Allows searching detailed information of a protocol across multiple Tatodesk platforms, such as **digital attendance, in-person, tickets or MP**.\
Ideal for checking status, dates and data of records already created.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://data.tatodesk.com/global/searchProtocol' \
--header 'TATODESK-API-KEY: {{TATODESK-GENERAL-MODEL}}' \
--data '{
"protocol": "20241106124207517",
"platform": []
}'
```
{% endcode %}
**Response Example:**
{% code lineNumbers="true" %}
```json
{
"result": [
{
"protocol": "20241106124207517",
"platform": "ticket",
"data": {
"ID": 151444,
"protocol": "20241106124207517",
"statusID": 6,
"status": "Resolved",
"date": "2024-11-06T15:42:07.517Z",
"departmentID": 24,
"department": "Support",
"userID": 1,
"userName": "Consenso Tecnologia",
"forms": [],
"additionalDatas": []
}
}
],
"error": null
}
```
{% endcode %}
#### Post Sessions Report
{% code lineNumbers="true" %}
```typescript
https://data.tatodesk.com/mp/listMessagingSessions
```
{% endcode %}
**Description:**\
This endpoint allows **to query messaging sessions reports** (webchat, WhatsApp, etc.) within a specific period.\
It is useful for audits, service metrics and tracking user interactions across multiple channels.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://data.tatodesk.com/mp/listMessagingSessions' \
--header 'TATODESK-API-KEY: {{TATODESK-GENERAL-MODEL}}' \
--data '{
"filter": {
"dateInitial": "01/03/2025 00:00",
"dateFinal": "19/03/2025 23:59"
},
"page": 0,
"limit": 500
}'
```
{% endcode %}
**Response Example:**
{% code lineNumbers="true" %}
```json
{
"sessions": [
{
"sessionID": "d6fd15ae-168c-473b-9576-582e3e2669b3",
"date": "2025-03-19T17:08:57.003Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-19T17:08:57.003Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "8aff8ec2-6c35-4ba9-bd8c-c9d848978d9d",
"date": "2025-03-19T17:05:59.161Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-19T17:05:59.161Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "abe1e68c-5bfc-4b26-882e-3ab245d18146",
"date": "2025-03-19T17:03:44.338Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-19T17:03:44.338Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "3dd4f051-66b9-4b22-811e-01e2d0edd334",
"date": "2025-03-19T17:01:27.995Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-19T17:01:27.995Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "675ae898-577e-4ffa-949a-e56cdae52730",
"date": "2025-03-19T16:21:43.984Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-19T16:21:43.984Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "398cf32d-4e14-4200-8382-444042df2665",
"date": "2025-03-19T16:19:32.600Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-19T16:19:32.600Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "05a8397c-6bd9-4552-8d20-8c589ea1540d",
"date": "2025-03-19T16:16:30.843Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-19T16:16:30.843Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "d944c0ad-704b-4836-9645-f988e48f088d",
"date": "2025-03-19T16:05:51.705Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-19T16:05:51.705Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "91445f46-2a30-4a31-96f9-3e281ed89647",
"date": "2025-03-19T16:03:29.357Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-19T16:03:29.357Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "3877358f-7f7f-4c58-8b7e-fdfea70a41d7",
"date": "2025-03-19T16:01:12.071Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-19T16:01:12.071Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "14af80ce-4906-4559-841d-064487e0fe5f",
"date": "2025-03-19T15:15:03.309Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-19T15:15:03.309Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "084ae008-3292-4aa1-97ee-038eb8c7eaef",
"date": "2025-03-19T15:00:38.834Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-19T15:00:38.834Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "e922907c-14de-40f0-aeec-662595b6f338",
"date": "2025-03-19T14:56:52.304Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-19T14:56:52.304Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "0f86499a-be58-46d6-9d55-a96c4197553f",
"date": "2025-03-19T11:30:09.858Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-19T11:30:09.858Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "090fcbc6-8467-4ee7-809d-4caf3fc5532f",
"date": "2025-03-18T15:53:58.096Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-18T15:53:58.096Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "652d813f-d20a-4fdb-a89d-a87325a68202",
"date": "2025-03-18T15:52:15.822Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-18T15:52:15.822Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "9e64f52d-6ab7-48f2-bd57-3275e0089624",
"date": "2025-03-18T15:01:13.048Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-18T15:01:13.048Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "c67dc161-3f66-4da4-856f-c01449be3a32",
"date": "2025-03-18T14:51:09.842Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-18T14:51:09.842Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "7a66b5fb-5889-4189-b273-848d1e347570",
"date": "2025-03-18T14:48:49.382Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-18T14:48:49.382Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "790f6530-71b2-4eab-bff8-7a8f2a21d939",
"date": "2025-03-18T14:45:39.854Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-18T14:45:39.854Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "035f930b-e50b-41bf-a669-69aa4c3ef978",
"date": "2025-03-18T14:44:52.108Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-18T14:44:52.108Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "5cb20230-7539-4348-95aa-4c506af8de88",
"date": "2025-03-18T14:43:19.908Z",
"messagingStatus": "running",
"contact": {
"name": "Beto Rosa Borges",
"whatsappID": "558196354429"
},
"channel": "whatsapp",
"createdAt": "2025-03-18T14:43:19.908Z",
"updatedAt": "2025-03-19T16:12:38.286Z",
"appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
"accountID": 241
},
{
"sessionID": "cb63a914-668c-4010-a29a-a0a402fdd352",
"date": "2025-03-14T16:12:04.738Z",
"messagingStatus": "running",
"contact": {
"name": "Beto Rosa Borges",
"whatsappID": "558196354429"
},
"channel": "whatsapp",
"createdAt": "2025-03-14T16:12:04.738Z",
"updatedAt": "2025-03-14T16:12:04.738Z",
"appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
"accountID": 241
},
{
"sessionID": "d2419e0f-93af-4c15-a6e9-bd447c06212e",
"date": "2025-03-14T16:02:27.400Z",
"messagingStatus": "running",
"contact": {
"name": "Beto Rosa Borges",
"whatsappID": "558196354429"
},
"channel": "whatsapp",
"createdAt": "2025-03-14T16:02:27.400Z",
"updatedAt": "2025-03-14T16:02:27.400Z",
"appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
"accountID": 241
},
{
"sessionID": "ebe9ef96-3d06-4b00-b904-4aa576ace5f2",
"date": "2025-03-14T14:33:08.243Z",
"messagingStatus": "running",
"contact": {
"name": "Almir Silvério Fonseca",
"whatsappID": "5518996315010"
},
"channel": "whatsapp",
"createdAt": "2025-03-14T14:33:08.243Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
"accountID": 241
},
{
"sessionID": "37f9b382-0c08-4fee-a00e-c541108e645b",
"date": "2025-03-14T14:15:34.788Z",
"messagingStatus": "running",
"contact": {
"name": "Almir Silvério Fonseca",
"whatsappID": "5518996315010"
},
"channel": "whatsapp",
"createdAt": "2025-03-14T14:15:34.788Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
"accountID": 241
},
{
"sessionID": "a39eee3a-2098-4be0-86c3-b9202382862e",
"date": "2025-03-14T10:07:24.892Z",
"messagingStatus": "running",
"contact": {
"name": "Almir Silvério Fonseca",
"whatsappID": "5518996315010"
},
"channel": "whatsapp",
"createdAt": "2025-03-14T10:07:24.892Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
"accountID": 241
},
{
"sessionID": "fce63789-9cbe-48ed-8092-247cf2dc5f9c",
"date": "2025-03-13T23:08:02.842Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-13T23:08:02.842Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "44932b15-1ad5-47fa-9fd8-c6c29012579f",
"date": "2025-03-13T20:54:21.351Z",
"messagingStatus": "running",
"contact": {
"name": "Hevandro Ferreira",
"whatsappID": "5518991233540"
},
"channel": "whatsapp",
"createdAt": "2025-03-13T20:54:21.351Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
"accountID": 241
},
{
"sessionID": "931c3071-6131-430b-aca1-11b3b7df325b",
"date": "2025-03-13T13:20:59.110Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-13T13:20:59.110Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "9d357854-6d2f-4cae-881a-0316b6d67c13",
"date": "2025-03-13T08:54:53.673Z",
"messagingStatus": "running",
"contact": {
"name": "Beto Rosa Borges",
"whatsappID": "558196354429"
},
"channel": "whatsapp",
"createdAt": "2025-03-13T08:54:53.673Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
"accountID": 241
},
{
"sessionID": "3a94fbf9-713d-4fba-9a51-10c870468c70",
"date": "2025-03-13T08:19:26.751Z",
"messagingStatus": "running",
"contact": {
"name": "Beto Rosa Borges",
"whatsappID": "558196354429"
},
"channel": "whatsapp",
"createdAt": "2025-03-13T08:19:26.751Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
"accountID": 241
},
{
"sessionID": "187a8949-2340-40be-af99-c2030a98eed9",
"date": "2025-03-13T08:12:48.701Z",
"messagingStatus": "running",
"contact": {
"name": "Beto Rosa Borges",
"whatsappID": "558196354429"
},
"channel": "whatsapp",
"createdAt": "2025-03-13T08:12:48.701Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
"accountID": 241
},
{
"sessionID": "11c5a445-bf09-4f0d-a7f7-8bbc312f30ae",
"date": "2025-03-13T08:05:56.532Z",
"messagingStatus": "running",
"contact": {
"name": "Almir Silvério Fonseca",
"whatsappID": "5518996315010"
},
"channel": "whatsapp",
"createdAt": "2025-03-13T08:05:56.532Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
"accountID": 241
},
{
"sessionID": "5377090b-3b68-43f5-b078-40aaefdd74b9",
"date": "2025-03-12T19:47:27.096Z",
"messagingStatus": "running",
"contact": {
"name": "Beto Rosa Borges",
"whatsappID": "558196354429"
},
"channel": "whatsapp",
"createdAt": "2025-03-12T19:47:27.096Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
"accountID": 241
},
{
"sessionID": "1d95d8ca-7d7f-411e-9514-a7a66f52de5e",
"date": "2025-03-12T17:23:17.742Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-12T17:23:17.742Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "8fd6bc60-e4fb-4e9d-803c-0fbb03e4c3bf",
"date": "2025-03-12T17:09:27.153Z",
"messagingStatus": "running",
"contact": {
"name": "Beto Rosa Borges",
"whatsappID": "558196354429"
},
"channel": "whatsapp",
"createdAt": "2025-03-12T17:09:27.153Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
"accountID": 241
},
{
"sessionID": "af99eb19-0dd0-45bd-9a4b-f5ffe3ea99a1",
"date": "2025-03-12T17:03:35.598Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-12T17:03:35.598Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "ddc38088-5e67-4e06-a69c-3284589c900b",
"date": "2025-03-12T17:01:03.861Z",
"messagingStatus": "running",
"contact": {
"name": "Moisés Simões",
"whatsappID": "558195492882"
},
"channel": "whatsapp",
"createdAt": "2025-03-12T17:01:03.861Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
"accountID": 241
},
{
"sessionID": "deec00db-bf8e-4e68-8c0d-35208678f000",
"date": "2025-03-12T16:41:22.146Z",
"messagingStatus": "running",
"contact": {
"name": "Beto Rosa Borges",
"whatsappID": "558196354429"
},
"channel": "whatsapp",
"createdAt": "2025-03-12T16:41:22.146Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
"accountID": 241
},
{
"sessionID": "5dd3a46d-30fd-442e-868a-ab7ba30cd180",
"date": "2025-03-12T16:31:53.753Z",
"messagingStatus": "running",
"contact": {
"name": "Almir Silvério Fonseca",
"whatsappID": "5518996315010"
},
"channel": "whatsapp",
"createdAt": "2025-03-12T16:31:53.753Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
"accountID": 241
},
{
"sessionID": "2128e562-626e-4ee4-801e-e67527f3bbd3",
"date": "2025-03-12T15:37:35.266Z",
"messagingStatus": "running",
"contact": {
"name": "Almir Silvério Fonseca",
"whatsappID": "5518996315010"
},
"channel": "whatsapp",
"createdAt": "2025-03-12T15:37:35.266Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
"accountID": 241
},
{
"sessionID": "45b35347-57db-4ae5-b5d6-8cafd3c73540",
"date": "2025-03-12T15:13:53.885Z",
"messagingStatus": "running",
"contact": {
"name": "Beto Rosa Borges",
"whatsappID": "558196354429"
},
"channel": "whatsapp",
"createdAt": "2025-03-12T15:13:53.885Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
"accountID": 241
},
{
"sessionID": "fbd06934-f3ea-46b6-b4c0-93b12e28c145",
"date": "2025-03-12T14:44:27.526Z",
"messagingStatus": "running",
"contact": {
"name": "Beto Rosa Borges",
"whatsappID": "558196354429"
},
"channel": "whatsapp",
"createdAt": "2025-03-12T14:44:27.526Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
"accountID": 241
},
{
"sessionID": "a8f91a21-7dc3-4065-8540-3d1af902a3bc",
"date": "2025-03-12T14:39:17.794Z",
"messagingStatus": "running",
"contact": {
"name": "Beto Rosa Borges",
"whatsappID": "558196354429"
},
"channel": "whatsapp",
"createdAt": "2025-03-12T14:39:17.794Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
"accountID": 241
},
{
"sessionID": "9dd205c1-e0a3-4d3d-b78e-0a1732c79028",
"date": "2025-03-12T14:32:08.036Z",
"messagingStatus": "running",
"contact": {
"name": "Beto Rosa Borges",
"whatsappID": "558196354429"
},
"channel": "whatsapp",
"createdAt": "2025-03-12T14:32:08.036Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
"accountID": 241
},
{
"sessionID": "925ef2f7-3bbe-4076-9f74-6b295437f966",
"date": "2025-03-12T14:15:16.000Z",
"messagingStatus": "running",
"contact": {
"name": "Beto Rosa Borges",
"whatsappID": "558196354429"
},
"channel": "whatsapp",
"createdAt": "2025-03-12T14:15:16.000Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
"accountID": 241
},
{
"sessionID": "1f59ec99-e1b5-49b8-b83a-b4beb30f8a53",
"date": "2025-03-12T12:57:43.755Z",
"messagingStatus": "running",
"contact": {
"name": "Vinicius Manzini",
"whatsappID": "5518981219436"
},
"channel": "whatsapp",
"createdAt": "2025-03-12T12:57:43.755Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
"accountID": 241
},
{
"sessionID": "a3374aeb-b109-4ce2-bd3e-7f3c4f8d5e11",
"date": "2025-03-12T12:57:03.085Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-12T12:57:03.085Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "ae1d9f26-d9d7-45b1-b38c-2b6bb629bf43",
"date": "2025-03-12T12:49:26.534Z",
"messagingStatus": "running",
"contact": {
"name": "Almir Silvério Fonseca",
"whatsappID": "5518996315010"
},
"channel": "whatsapp",
"createdAt": "2025-03-12T12:49:26.534Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
"accountID": 241
},
{
"sessionID": "10309d6d-f7b9-4764-a2cc-aab230b55631",
"date": "2025-03-12T12:46:40.752Z",
"messagingStatus": "running",
"contact": {
"name": "Beto Rosa Borges",
"whatsappID": "558196354429"
},
"channel": "whatsapp",
"createdAt": "2025-03-12T12:46:40.752Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
"accountID": 241
},
{
"sessionID": "9b1d7848-ba87-4bc9-9c9b-3bec2cb328ea",
"date": "2025-03-12T12:31:45.724Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-12T12:31:45.724Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "cc1948da-9ec3-49fd-9905-4d05e5008378",
"date": "2025-03-12T12:26:53.112Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-12T12:26:53.112Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "fb2ff5c7-d22c-4ffb-b257-c290377a17a1",
"date": "2025-03-12T12:17:09.086Z",
"messagingStatus": "running",
"contact": {
"name": "Beto Rosa Borges",
"whatsappID": "558196354429"
},
"channel": "whatsapp",
"createdAt": "2025-03-12T12:17:09.086Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
"accountID": 241
},
{
"sessionID": "f89eb51f-eded-42fc-8f26-ce3e300f6b19",
"date": "2025-03-12T11:11:05.134Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-12T11:11:05.134Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "1a39c7e5-8ddf-428e-bc67-4ab0cd28fdd8",
"date": "2025-03-12T11:02:06.416Z",
"messagingStatus": "running",
"contact": {
"name": "Beto Rosa Borges",
"whatsappID": "558196354429"
},
"channel": "whatsapp",
"createdAt": "2025-03-12T11:02:06.416Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
"accountID": 241
},
{
"sessionID": "ebc76b6c-5f9d-4822-971f-3529ff554782",
"date": "2025-03-12T10:39:49.864Z",
"messagingStatus": "running",
"contact": {
"name": "Beto Rosa Borges",
"whatsappID": "558196354429"
},
"channel": "whatsapp",
"createdAt": "2025-03-12T10:39:49.864Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
"accountID": 241
},
{
"sessionID": "9137b2f9-270b-4f87-9473-75aa6efd7a1b",
"date": "2025-03-12T10:22:20.937Z",
"messagingStatus": "running",
"contact": {
"name": "Beto Rosa Borges",
"whatsappID": "558196354429"
},
"channel": "whatsapp",
"createdAt": "2025-03-12T10:22:20.937Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
"accountID": 241
},
{
"sessionID": "6171443b-a30a-4c91-bc37-be7256915f8b",
"date": "2025-03-12T09:19:55.752Z",
"messagingStatus": "running",
"contact": {
"name": "Beto Rosa Borges",
"whatsappID": "558196354429"
},
"channel": "whatsapp",
"createdAt": "2025-03-12T09:19:55.752Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
"accountID": 241
},
{
"sessionID": "82eb026e-1c7c-42b5-bc85-4bcc0fce87e3",
"date": "2025-03-12T09:17:01.046Z",
"messagingStatus": "running",
"contact": {
"name": "Almir Silvério Fonseca",
"whatsappID": "5518996315010"
},
"channel": "whatsapp",
"createdAt": "2025-03-12T09:17:01.046Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
"accountID": 241
},
{
"sessionID": "2eeeb688-2a4f-4347-aab2-e2ad30944244",
"date": "2025-03-12T09:13:13.375Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-12T09:13:13.375Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "11dd4fe5-edc6-4117-bd15-0e4dcb1b3f8c",
"date": "2025-03-11T16:29:27.776Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-11T16:29:27.776Z",
"updatedAt": "2025-04-06T20:00:00.000Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "7505e213-f0e2-4163-ad39-2c54329d2730",
"date": "2025-03-11T14:53:13.941Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-11T14:53:13.941Z",
"updatedAt": "2025-03-11T14:53:14.268Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "05c4244a-b902-4264-bb90-fb9bdcdd5292",
"date": "2025-03-11T14:49:50.832Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-11T14:49:50.832Z",
"updatedAt": "2025-03-11T14:49:51.128Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "e92236f0-0482-4daf-b859-04f29f90df20",
"date": "2025-03-11T14:43:23.590Z",
"messagingStatus": "running",
"contact": {
"name": "Beto Rosa Borges",
"whatsappID": "558196354429"
},
"channel": "whatsapp",
"createdAt": "2025-03-11T14:43:23.590Z",
"updatedAt": "2025-03-11T14:43:23.590Z",
"appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
"accountID": 241
},
{
"sessionID": "ca9402bc-2cc1-4f1d-9cbd-d67194bf7543",
"date": "2025-03-11T14:33:47.552Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-11T14:33:47.552Z",
"updatedAt": "2025-03-11T14:33:47.863Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "d12ab7b0-e236-4eba-9441-39f79b28185c",
"date": "2025-03-11T14:28:27.206Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-11T14:28:27.206Z",
"updatedAt": "2025-03-11T14:28:27.483Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "6e74faee-4a7b-4382-a784-6fdd697ac729",
"date": "2025-03-11T14:20:40.393Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-11T14:20:40.393Z",
"updatedAt": "2025-03-11T14:20:40.717Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "4b7bf8d8-1ae7-4485-a973-0e9d5d210c01",
"date": "2025-03-11T14:19:55.678Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-11T14:19:55.678Z",
"updatedAt": "2025-03-11T14:19:56.029Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "ed5dc4f6-e5e5-49b4-87cd-460311deb332",
"date": "2025-03-11T13:40:21.493Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-11T13:40:21.493Z",
"updatedAt": "2025-03-11T13:40:21.804Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "e6a949e7-f438-4525-9658-2d40db85abf1",
"date": "2025-03-11T13:39:38.112Z",
"messagingStatus": "running",
"contact": {
"name": "Almir Silvério Fonseca",
"whatsappID": "5518996315010"
},
"channel": "whatsapp",
"createdAt": "2025-03-11T13:39:38.112Z",
"updatedAt": "2025-03-11T13:41:35.481Z",
"appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
"accountID": 241
},
{
"sessionID": "35923620-d284-47d7-b4ae-5f4830c97bcf",
"date": "2025-03-11T13:33:50.478Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-11T13:33:50.478Z",
"updatedAt": "2025-03-11T13:33:50.797Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "2f4e7ac0-8cba-451d-9f68-0666cfc3bcf2",
"date": "2025-03-11T10:59:45.140Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-11T10:59:45.140Z",
"updatedAt": "2025-03-11T10:59:45.569Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "b5121ed7-d293-4d97-98ad-e33e899585e2",
"date": "2025-03-11T10:55:43.666Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-11T10:55:43.666Z",
"updatedAt": "2025-03-11T10:55:44.045Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "68cca655-3313-463e-9605-a24f4cd47f69",
"date": "2025-03-10T15:22:52.923Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-10T15:22:52.923Z",
"updatedAt": "2025-03-10T15:22:53.319Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
},
{
"sessionID": "a620ba3c-e8e0-4904-ab95-142a8a4c64ae",
"date": "2025-03-10T09:08:59.409Z",
"messagingStatus": "running",
"contact": {
"ip": "10.0.5.168"
},
"channel": "webchat",
"createdAt": "2025-03-10T09:08:59.409Z",
"updatedAt": "2025-03-10T09:08:59.990Z",
"appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
"accountID": 241
}
],
"count": "76",
"error": null
}
```
{% endcode %}
#### POST Grouped Journey Report
{% code lineNumbers="true" %}
```typescript
https://data.tatodesk.com/chatbot/listChatbotJourneyEventsGrouped
```
{% endcode %}
**Description:**\
Returns **chatbot journey events grouped** by level and tag, within a defined period.\
Ideal for user flow reports and performance analysis of automated journeys.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://data.tatodesk.com/chatbot/listChatbotJourneyEventsGrouped' \
--header 'TATODESK-API-KEY: {{TATODESK-GENERAL-MODEL}}' \
--data '{
"filter": {
"dateInitial": "03/01/2025",
"dateFinal": "03/19/2025",
"chatbotID": "",
"chatbotJourneyID": "9f4ee55d-4084-48cc-bbab-362205f82ffb"
}
}'
```
{% endcode %}
**Response Example:**
{% code lineNumbers="true" %}
```json
{
"events": [
{
"journeyID": "1f89759b-deba-4495-98d2-cc1f14023ce2",
"journeyName": "Teste Adauto 1111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
"levelID": "b9ae080e-7b0b-44bc-8e2b-f07a6cfc2849",
"levelDescription": "test 1",
"level": 1,
"chatbotEventTagName": "FIRST_ACCESS",
"count": "1"
},
{
"journeyID": "688a1139-af13-4b95-b41d-c63109c53003",
"journeyName": "21",
"levelID": "f218879f-4990-490d-82eb-27e84552878c",
"levelDescription": "Level 1",
"level": 1,
"chatbotEventTagName": "FIRST_ACCESS",
"count": "1"
},
{
"journeyID": "7da3e4e2-bd3c-47d1-88f2-e2d3db74066f",
"journeyName": "2 journey",
"levelID": "faabbbc3-f9f5-452b-8a60-2ec2a4bcf3b8",
"levelDescription": "Level 3",
"level": 1,
"chatbotEventTagName": "FIRST_ACCESS",
"count": "1"
},
{
"journeyID": "7da3e4e2-bd3c-47d1-88f2-e2d3db74066f",
"journeyName": "2 journey",
"levelID": "d9b733cc-2006-47b8-bc41-8aa5c19876c6",
"levelDescription": "Level 2",
"level": 2,
"chatbotEventTagName": "FIRST_ACCESS",
"count": "1"
},
{
"journeyID": "9f4ee55d-4084-48cc-bbab-362205f82ffb",
"journeyName": "victor journey",
"levelID": "c9cb433e-48e6-4023-8448-e54dac6706b1",
"levelDescription": "Level 1",
"level": 1,
"chatbotEventTagName": "FIRST_ACCESS",
"count": "1"
},
{
"journeyID": "df459aa5-9fb9-4e4e-ae9f-ff9bfff41bb8",
"journeyName": "new journey",
"levelID": "63ffb9df-f21d-46f5-bba3-94218e289a52",
"levelDescription": "Level 1",
"level": 1,
"chatbotEventTagName": "FIRST_ACCESS",
"count": "1"
},
{
"journeyID": "df459aa5-9fb9-4e4e-ae9f-ff9bfff41bb8",
"journeyName": "new journey",
"levelID": "63ffb9df-f21d-46f5-bba3-94218e289a52",
"levelDescription": "Level 1",
"level": 1,
"chatbotEventTagName": "FIRST_ACCESS",
"count": "1"
}
],
"error": null
}
```
{% endcode %}
#### POST Detailed Journey Report
{% code lineNumbers="true" %}
```typescript
https://data.tatodesk.com/chatbot/listChatbotJourneyEventsDetailed
```
{% endcode %}
**Description:**\
Returns **all individual events** of a chatbot journey within a period, with detailed information about each interaction, session and step the user went through.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://data.tatodesk.com/chatbot/listChatbotJourneyEventsDetailed' \
--header 'TATODESK-API-KEY: {{TATODESK-GENERAL-MODEL}}' \
--data '{
"filter": {
"dateInitial": "03/01/2025",
"dateFinal": "03/19/2025",
"chatbotID": "",
"chatbotJourneyID": "9f4ee55d-4084-48cc-bbab-362205f82ffb"
},
"page": 0,
"limit": 10
}'
```
{% endcode %}
**Response Example:**
{% code lineNumbers="true" %}
```json
{
"count": "1",
"events": [
{
"journeyID": "1f89759b-deba-4495-98d2-cc1f14023ce2",
"journeyName": "Teste Adauto 1111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
"levelID": "b9ae080e-7b0b-44bc-8e2b-f07a6cfc2849",
"levelDescription": "test 1",
"level": 1,
"chatbotEventTagName": "FIRST_ACCESS",
"date": "2025-03-13T17:38:24.081Z",
"sessionID": "fdfb1379-4e3d-493f-9054-8dc15d47765d",
"appStoreType": "webchat"
},
{
"journeyID": "688a1139-af13-4b95-b41d-c63109c53003",
"journeyName": "21",
"levelID": "f218879f-4990-490d-82eb-27e84552878c",
"levelDescription": "Level 1",
"level": 1,
"chatbotEventTagName": "FIRST_ACCESS",
"date": "2025-03-13T17:38:24.081Z",
"sessionID": "fdfb1379-4e3d-493f-9054-8dc15d47765d",
"appStoreType": "webchat"
},
{
"journeyID": "7da3e4e2-bd3c-47d1-88f2-e2d3db74066f",
"journeyName": "2 journey",
"levelID": "faabbbc3-f9f5-452b-8a60-2ec2a4bcf3b8",
"levelDescription": "Level 3",
"level": 1,
"chatbotEventTagName": "FIRST_ACCESS",
"date": "2025-03-13T17:38:24.081Z",
"sessionID": "fdfb1379-4e3d-493f-9054-8dc15d47765d",
"appStoreType": "webchat"
},
{
"journeyID": "9f4ee55d-4084-48cc-bbab-362205f82ffb",
"journeyName": "victor journey",
"levelID": "c9cb433e-48e6-4023-8448-e54dac6706b1",
"levelDescription": "Level 1",
"level": 1,
"chatbotEventTagName": "FIRST_ACCESS",
"date": "2025-03-13T17:38:24.081Z",
"sessionID": "fdfb1379-4e3d-493f-9054-8dc15d47765d",
"appStoreType": "webchat"
},
{
"journeyID": "df459aa5-9fb9-4e4e-ae9f-ff9bfff41bb8",
"journeyName": "new journey",
"levelID": "63ffb9df-f21d-46f5-bba3-94218e289a52",
"levelDescription": "Level 1",
"level": 1,
"chatbotEventTagName": "FIRST_ACCESS",
"date": "2025-03-13T17:38:24.081Z",
"sessionID": "fdfb1379-4e3d-493f-9054-8dc15d47765d",
"appStoreType": "webchat"
}
],
"error": null
}
```
{% endcode %}
#### POST Ad-hoc Notifications Report
{% code lineNumbers="true" %}
```typescript
https://data.tatodesk.com/mkt/listLooseNotificationsReport
```
{% endcode %}
**Description:**\
Returns a **detailed report of loose notifications** (SMS, email or WhatsApp) sent manually or via API, allowing filtering by period, service, user, API key or template.\
Ideal for **audit, dispatch control and status tracking**.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://data.tatodesk.com/mkt/listLooseNotificationsReport' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
"filter": {
"dateInitial": "01/01/2021",
"dateFinal": "05/01/2025",
"mktTemplateIDs": [],
"userIDs": [25],
"apiKeyIDs": [],
"service": "whatsapp"
},
"page": 0,
"limit": 10
}'
```
{% endcode %}
#### POST Get Session
{% code lineNumbers="true" %}
```typescript
https://data.tatodesk.com/mp/getMessagingSession
```
{% endcode %}
**Description:**\
Returns the **complete details of a messaging session** (for example, from WhatsApp), including status, associated contact, channel and creation and update times.\
It is useful for **consulting information about a specific conversation**, validating service status or integrating session data into reports.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://data.tatodesk.com/chatbot/listChatbotEventFeedbacksByFilter' \
--header 'TATODESK-API-KEY: {{API_KEY_MODEL}}' \
--data '{
"filter": {
"initialDate": "05/15/2025",
"finalDate": "05/21/2025",
"chatbotTagIds": [""],
"sessionID": ""
},
"page": 0,
"limit": 0
}'
```
{% endcode %}
**Response Example:**
{% code lineNumbers="true" %}
```json
{
"conversations": [
{
"chatbotEventFeedbackID": "46a7e47a-edcb-4f2b-90ed-a0bccf41ac20",
"rate": null,
"observation": "hi",
"isSolvedProblem": null,
"chatbotEventTagID": null,
"chatbotID": "ca94fe34-7581-4268-84bc-7f3383e9ab08",
"sessionID": "174a196b-fb1b-4be6-ac21-8c9e0014fdea",
"accountID": 241,
"createdAt": "2025-05-19T09:25:36.497Z",
"updatedAt": "2025-05-19T09:25:36.497Z"
},
{
"chatbotEventFeedbackID": "50af9fd8-e076-42c9-91aa-b982725eaeb8",
"rate": 1,
"observation": "Nothing",
"isSolvedProblem": null,
"chatbotEventTagID": null,
"chatbotID": "ca94fe34-7581-4268-84bc-7f3383e9ab08",
"sessionID": "229c8ff5-eb6c-48e1-9114-32cefb714c95",
"accountID": 241,
"createdAt": "2025-05-16T17:33:32.293Z",
"updatedAt": "2025-05-16T17:33:32.293Z"
}
],
"count": "2",
"error": null
}
```
{% endcode %}
#### POST List Reviews
{% code lineNumbers="true" %}
```typescript
https://data.tatodesk.com/chatbot/listChatbotEventFeedbacksByFilter
```
{% endcode %}
**Description:**\
Returns the list of feedbacks (ratings and observations) submitted by users in interactions with the chatbot.\
Allows filtering records by date range or by a specific session number, and also enables pagination of results.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://data.tatodesk.com/chatbot/listChatbotEventFeedbacksByFilter' \
--header 'TATODESK-API-KEY: {{API_KEY_MODEL}}' \
--data '{
"filter": {
"initialDate": "05/15/2025",
"finalDate": "05/21/2025",
"chatbotTagIds": [""],
"sessionID": ""
},
"page": 0,
"limit": 0
}'
```
{% endcode %}
**Response Example:**
{% code lineNumbers="true" %}
```json
{
"conversations": [
{
"chatbotEventFeedbackID": "46a7e47a-edcb-4f2b-90ed-a0bccf41ac20",
"rate": null,
"observation": "hi",
"isSolvedProblem": null,
"chatbotEventTagID": null,
"chatbotID": "ca94fe34-7581-4268-84bc-7f3383e9ab08",
"sessionID": "174a196b-fb1b-4be6-ac21-8c9e0014fdea",
"accountID": 241,
"createdAt": "2025-05-19T09:25:36.497Z",
"updatedAt": "2025-05-19T09:25:36.497Z"
},
{
"chatbotEventFeedbackID": "50af9fd8-e076-42c9-91aa-b982725eaeb8",
"rate": 1,
"observation": "Nothing",
"isSolvedProblem": null,
"chatbotEventTagID": null,
"chatbotID": "ca94fe34-7581-4268-84bc-7f3383e9ab08",
"sessionID": "229c8ff5-eb6c-48e1-9114-32cefb714c95",
"accountID": 241,
"createdAt": "2025-05-16T17:33:32.293Z",
"updatedAt": "2025-05-16T17:33:32.293Z"
}
],
"count": "2",
"error": null
}
```
{% endcode %}
### CRM
#### POST List Objects
{% code lineNumbers="true" %}
```typescript
https://api-v2.tatodesk.com/crm/v1/listObject
```
{% endcode %}
**Description:**\
Returns the **records of a custom object** created in the module **CRM** (e.g.: "Sales", "Customers", "Orders").\
Allows applying **filters, sorts and selection of specific fields**, making it possible to build dynamic reports and queries.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://api-v2.tatodesk.com/crm/v1/listObject' \
--header 'TATODESK-API-KEY: {{API-KEY-CRM}}'
```
{% endcode %}
**Response Example:**
{% code lineNumbers="true" %}
```json
{
"dataObject": {
"tableName": "Sales",
"tableColumns": [
{
"name": "Product",
"type": "text",
"values": null
},
{
"name": "Value",
"type": "numeric",
"values": null
},
{
"name": "Date",
"type": "timestamp",
"values": null
},
{
"name": "Status",
"type": "type",
"values": [
{
"name": "Processing",
"color": "#e70d0d"
},
{
"name": "Paid",
"color": "#504e4e"
},
{
"name": "Delivered",
"color": "#14e117"
}
]
},
{
"name": "User",
"type": "integer",
"values": null
}
],
"tableData": []
},
"count": "0",
"error": null
}
```
{% endcode %}
#### POST Create Object
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/crm/v1/insertObject
```
{% endcode %}
**Description:**\
Creates a **new record in a CRM object** (such as "Sales", "Customers" or "Orders"), providing the corresponding fields and values.\
The system performs **automatic validation of required fields** defined in the object configuration.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://api-v2.tatodesk.com/crm/v1/insertObject' \
--header 'TATODESK-API-KEY: {{API-KEY-CRM}}'
```
{% endcode %}
**Response Example:**
{% code lineNumbers="true" %}
```json
{
"dataObject": {
"accountID": 1,
"createdAt": "2025-09-11T20:20:51.031Z",
"updatedAt": "2025-09-11T20:20:51.031Z",
"id": "8b7d02b9-bff1-40d2-81ee-10ac90886d21",
"Produto": "Soda"
},
"error": null
}
```
{% endcode %}
#### POST Edit Object
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/crm/v1/updateObject
```
{% endcode %}
**Description:**\
Removes a **specific record** from a CRM object (such as "sales", "customers", "orders" etc.).\
Deletion is done based on the **record ID**, and **not** on the object ID or CRM structure.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://api-v2.tatodesk.com/crm/v1/deleteObject' \
--header 'TATODESK-API-KEY: {{API-KEY-CRM}}'
```
{% endcode %}
**Response Example:**
{% code lineNumbers="true" %}
```json
{
"error": null
}
```
{% endcode %}
#### POST Delete Object
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/crm/v1/deleteObject
```
{% endcode %}
**Description:**\
Removes a specific record from a custom object created in the CRM module (e.g.: "Sales", "Customers", "Orders").\
Deletion is done by providing the entity name (`apiName`) and the unique identifier (`ID`) of the desired record.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://api-v2.tatodesk.com/crm/v1/deleteObject' \
--header 'TATODESK-API-KEY: {{API-KEY-CRM}}'
```
{% endcode %}
**Response Example:**
{% code lineNumbers="true" %}
```json
{
"error": null
}
```
{% endcode %}
## Contact Center
#### POST List Departments
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/cc/v1/listDepartments
```
{% endcode %}
**Description:**\
Returns a paginated list of **active and inactive departments** registered in the Contact Center.\
This endpoint is useful to query the name and ID of departments, which can be used in other integrations (such as ticket routing, attendances, among others).
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://api.tatodesk.com/cc/v1/listDepartments' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
"page": 0,
"limit": 10
}'
```
{% endcode %}
**Response Example:**
{% code lineNumbers="true" %}
```json
{
"departments": [
{
"ID": 334,
"name": "am-civil",
"isActive": 1
},
{
"ID": 335,
"name": "am-criminal",
"isActive": 1
},
{
"ID": 336,
"name": "am-familia",
"isActive": 1
},
{
"ID": 337,
"name": "am-plantao",
"isActive": 1
},
{
"ID": 52,
"name": "REFIS Service",
"isActive": 1
},
{
"ID": 7,
"name": "Collections",
"isActive": 1
},
{
"ID": 3,
"name": "Account",
"isActive": 1
},
{
"ID": 68,
"name": "DEPART FIESC",
"isActive": 1
},
{
"ID": 726,
"name": "Department with limit",
"isActive": 1
},
{
"ID": 1110,
"name": "Test Dept.",
"isActive": 1
}
],
"count": 29,
"error": null
}
```
{% endcode %}
#### POST List Service Groups
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/cc/v1/listAttendanceGroups
```
{% endcode %}
**Description:**\
Returns a paginated list of **attendance groups** linked to specific departments.\
Attendance groups organize operators and schedules, allowing the definition of rules and service queues.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://api.tatodesk.com/cc/v1/listAttendanceGroups' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
"filter": {
"attendanceGroupIDs":[],
"departmentIDs": [],
"isNormalOpenningHour": 1
},
"page": 0,
"limit": 10
}'
```
{% endcode %}
**Response Example:**
{% code lineNumbers="true" %}
```json
{
"attendanceGroups": [
{
"ID": 305,
"name": "Presentation",
"description": "Presentation 10/09/24",
"isActive": 1,
"departmentID": 7
},
{
"ID": 64,
"name": "Collections",
"description": "Collections Group",
"isActive": 2,
"departmentID": 7
},
{
"ID": 6,
"name": "Accounts",
"description": "Accounts",
"isActive": 1,
"departmentID": 3
},
{
"ID": 13,
"name": "Donations",
"description": "Donations",
"isActive": 2,
"departmentID": 3
},
{
"ID": 3,
"name": "Insufficient documents to parcel",
"description": "Insufficient documents to parcel",
"isActive": 2,
"departmentID": 2
},
{
"ID": 144,
"name": "General",
"description": "General",
"isActive": 1,
"departmentID": 63
},
{
"ID": 21,
"name": "Large Companies",
"description": "Large Companies",
"isActive": 2,
"departmentID": 17
},
{
"ID": 74,
"name": "Real estate above 1,000,000.00",
"description": "Real estate above 1,000,000.00",
"isActive": 2,
"departmentID": 3
},
{
"ID": 135,
"name": "Interior",
"description": "Interior",
"isActive": 2,
"departmentID": 338
},
{
"ID": 75,
"name": "I am already a customer",
"description": "I am already a customer",
"isActive": 2,
"departmentID": 67
}
],
"count": 43,
"error": null
}
```
{% endcode %}
#### POST List Specialties
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/cc/v1/listGroupSpecializations
```
{% endcode %}
**Description:**\
Returns a list of **specializations** (or subdivisions) linked to a specific attendance group.\
Each specialization represents an area, locality or type of service within an attendance group.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://api.tatodesk.com/cc/v1/listGroupSpecializations' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
"filter": {
"attendanceGroupID": 455,
"groupSpecializationIDs": [],
"departmentIDs": [],
"isNormalOpenningHour": 1
},
"page": 0,
"limit": 10
}'
```
{% endcode %}
**Response Example:**
{% code lineNumbers="true" %}
```json
{
"specializations": [
{
"ID": 165,
"name": "Aracaju",
"isActive": 1,
"attendanceGroupID": 455
},
{
"ID": 166,
"name": "Nossa Senhora do Socorro Piedade/Soledade",
"isActive": 1,
"attendanceGroupID": 455
}
],
"count": 2,
"error": null
}
```
{% endcode %}
#### POST List Subspecialties
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/cc/v1/listSubSpecializations
```
{% endcode %}
**Description:**\
Returns a list of **subspecialties** associated with a specific specialization (or group of specializations).\
Each subspecialty represents a more detailed subdivision within a specialization — such as a neighborhood, sector or service category.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://api.tatodesk.com/cc/v1/listSubSpecializations' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
"filter": {
"groupSpecializationID": 165,
"subSpecializationIDs": [],
"departmentIDs": [],
"isNormalOpenningHour": 1
},
"page": 0,
"limit": 10
}'
```
{% endcode %}
**Response Example:**
{% code lineNumbers="true" %}
```json
{
"subSpecializations": [
{
"ID": 375,
"name": "13 de Julho",
"isActive": 1,
"groupSpecializationID": 165
},
{
"ID": 376,
"name": "Coroa do meio",
"isActive": 1,
"groupSpecializationID": 165
}
],
"count": 2,
"error": null
}
```
{% endcode %}
#### POST List Areas
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/cc/v1/listAreas
```
{% endcode %}
**Description:**\
Returns a list of **areas** associated with a specific subspecialization.\
Areas represent operational or thematic subdivisions within a subspecialization — for example, sectors, types of service or specific service categories.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://api.tatodesk.com/cc/v1/listAreas' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
"filter": {
"subspecializationID": 375,
"areaIDs": [],
"departmentIDs": [],
"isNormalOpenningHour": 1
},
"page": 0,
"limit": 10
}'
```
{% endcode %}
**Response Example:**
{% code lineNumbers="true" %}
```json
{
"areas": [
{
"ID": 940,
"name": "Bars",
"isActive": 1,
"subspecializationID": 375,
"departmentID": 337
},
{
"ID": 941,
"name": "Restaurants",
"isActive": 1,
"subspecializationID": 375,
"departmentID": 52
}
],
"count": 2,
"error": null
}
```
{% endcode %}
#### POST List Subareas
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/cc/v1/listSubAreas
```
{% endcode %}
**Description:**\
This endpoint returns the list of **subareas** associated with a **specific area**.\
Subareas represent subdivisions within a registered area.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://api.tatodesk.com/cc/v1/listSubAreas' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
"filter": {
"areaID": 940,
"subAreaIDs": [],
"departmentIDs": [],
"isNormalOpenningHour": 1
},
"page": 0,
"limit": 10
}'
```
{% endcode %}
**Response Example:**
{% code lineNumbers="true" %}
```json
{
"subAreas": [
{
"ID": 700,
"name": "Budega do Jorjão",
"isActive": 1,
"areaID": 940,
"departmentID": null
},
{
"ID": 699,
"name": "Chopp 13",
"isActive": 1,
"areaID": 940,
"departmentID": null
}
],
"count": 2,
"error": null
}
```
{% endcode %}
#### POST List Service Schedules
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/cc/v1/listOpeningHours
```
{% endcode %}
**Description:**\
Returns the list of opening hours for a specific attendance group, filtering by **attendance group**, **specialization**, **subspecialization**, **area** and **subarea**.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://api.tatodesk.com/cc/v1/listOpeningHours' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
"attendanceGroupID": 455,
"groupSpecializationID": 165,
"subSpecializationID": 375,
"areaID": 940,
"subAreaID": 699
}'
```
{% endcode %}
**Response Example:**
{% code lineNumbers="true" %}
```json
{
"object": "general",
"openingHours": [
{
"dayID": 1,
"day": "Sunday",
"startTime": "00:00:00",
"endTime": "23:59:00"
},
{
"dayID": 2,
"day": "Monday",
"startTime": "00:01:00",
"endTime": "23:59:00"
},
{
"dayID": 3,
"day": "Tuesday",
"startTime": "10:19:00",
"endTime": "19:19:00"
},
{
"dayID": 3,
"day": "Tuesday",
"startTime": "22:53:00",
"endTime": "23:53:00"
},
{
"dayID": 4,
"day": "Wednesday",
"startTime": "00:00:00",
"endTime": "23:59:00"
},
{
"dayID": 5,
"day": "Thursday",
"startTime": "00:00:00",
"endTime": "23:59:00"
},
{
"dayID": 6,
"day": "Friday",
"startTime": "14:00:00",
"endTime": "23:59:00"
},
{
"dayID": 7,
"day": "Saturday",
"startTime": "00:00:00",
"endTime": "23:12:00"
}
],
"error": null
}
```
{% endcode %}
#### POST List Service Schedule Exceptions
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/cc/v1/listOpeningHourExceptions
```
{% endcode %}
**Description:**\
Returns the **exceptions** of the registered opening hours for a given group, specialty, subspecialty, area and subarea.
These exceptions represent **specific changes** to the normal operating hours, such as holidays, maintenance or specific events that modify the standard availability.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://api.tatodesk.com/cc/v1/listOpeningHourExceptions' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
"attendanceGroupID": 455,
"groupSpecializationID": 165,
"subSpecializationID": 375,
"areaID": 940,
"subAreaID": 699
}'
```
{% endcode %}
**Response Example:**
{% code lineNumbers="true" %}
```json
{
"object": "general",
"exceptions": [
{
"description": "test",
"date": "2024-11-22",
"startTime": "00:00:00",
"endTime": "23:59:00",
"observation": null
},
{
"description": "Labor Day",
"date": "2025-05-01",
"startTime": "00:00:00",
"endTime": "23:59:00",
"observation": "Labor Day"
},
{
"description": "Universal fraternization holiday.",
"date": "2023-01-01",
"startTime": "00:00:00",
"endTime": "23:59:00",
"observation": "Universal fraternization holiday."
},
{
"description": "New Year.",
"date": "2023-01-01",
"startTime": "00:00:00",
"endTime": "23:59:00",
"observation": "New Year."
},
{
"description": "Recife municipal holiday",
"date": "2021-12-08",
"startTime": "00:00:00",
"endTime": "23:59:00",
"observation": "Recife municipal holiday"
},
{
"description": "test adauto",
"date": "2025-05-28",
"startTime": "00:00:00",
"endTime": "23:59:00",
"observation": "testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeetesteeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeetesteeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeetesteeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee"
}
],
"error": null
}
```
{% endcode %}
## Pulse
#### POST Create App Session
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/pulse/v1/createAppSession
```
{% endcode %}
**Description:**\
This route creates a **app session**, allowing the system to recognize and authenticate an app that is connecting to the TatoDesk API.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://api-v2.tatodesk.com/pulse/v1/createAppSession' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
"client": {
"clientVersionApp": "v1.0.0",
"appID": "8cba24be-596e-4758-85bc-b4964ff78f98"
},
"payload": {
"os": "android",
"language": "pt-BR",
"screen": "1200x800",
"platform": "mobile"
}
}'
```
{% endcode %}
**Response Example:**
{% code lineNumbers="true" %}
```json
{
"session": "c23a31c7-7bf1-4972-855a-da6dad2bc5d9",
"error": null
}
```
{% endcode %}
#### POST Register event
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/pulse/v1/createEvent
```
{% endcode %}
**Description:**\
This route registers **custom events** related to an app session in TatoDesk.\
It is used to track user actions within the app — such as clicks, accesses, screen views, errors or any type of event you want to track.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://api.tatodesk.com/pulse/v1/createEvent' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
"data": { "METADATA_KEY": "METADATA_VALUE" },
"appID": "8cba24be-596e-4758-85bc-b4964ff78f98",
"appSessionID": "c23a31c7-7bf1-4972-855a-da6dad2bc5d9",
"tag": "Custom Session"
}
'
```
{% endcode %}
## Chatbot
#### POST List Journeys
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/chatbot/v1/listChatbotJourneys
```
{% endcode %}
**Description:** This route returns the list of **chatbot journeys** registered in the system.\
Each journey represents an automated support flow, and can be **active** or **inactive**.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://api.tatodesk.com/chatbot/v1/listChatbotJourneys' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
"page": 0,
"limit": 10
}'
```
{% endcode %}
**Response Example:**
{% code lineNumbers="true" %}
```json
{
"journeys": [
{
"ID": "7da3e4e2-bd3c-47d1-88f2-e2d3db74066f",
"description": "2 journey",
"isActive": 1
},
{
"ID": "688a1139-af13-4b95-b41d-c63109c53003",
"description": "21",
"isActive": 1
},
{
"ID": "d3ab6c40-9e3d-4d1a-b463-1077904079fc",
"description": "Success Journey test atos",
"isActive": 1
},
{
"ID": "95f19173-ea4b-4cb0-8c1f-e88da925fce1",
"description": "Test Adauto ",
"isActive": 1
},
{
"ID": "639a640b-5392-4526-9d2e-ee0575a14e6c",
"description": "Test Adauto 1",
"isActive": 1
},
{
"ID": "ed9d79b3-0442-47a8-abfe-55528c75168a",
"description": "Test Adauto 111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
"isActive": 1
},
{
"ID": "1f89759b-deba-4495-98d2-cc1f14023ce2",
"description": "Test Adauto 1111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
"isActive": 1
},
{
"ID": "7146dcdb-b90f-40c9-8c0b-a107720091c1",
"description": "Test David",
"isActive": 1
},
{
"ID": "e4dd3c45-5ba9-421c-bfac-465ae741168c",
"description": "Test David bot",
"isActive": 1
},
{
"ID": "86670f0d-048f-4c10-a498-f003eb6e2298",
"description": "Test Emanuel",
"isActive": 1
}
],
"count": 14,
"error": null
}
```
{% endcode %}
## Survey
#### POST Forms
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/survey/v1/getSurveyForm
```
{% endcode %}
**Description:** This route returns the **full details of a survey form** specific in the system. It is used to view the information configured in the form, such as name, description, image, colors and scale type.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://api.tatodesk.com/survey/v1/getSurveyForm' \
--header 'TATODESK-API-KEY: bc363b4a-ebeb-4625-97e6-e74d2def2723' \
--data '{
"surveyFormID": "76bfdc3d-7185-4c9d-a520-527574e23f25"
}'
```
{% endcode %}
**Response Example:**
{% code lineNumbers="true" %}
```json
{
"surveyForm": {
"surveyFormID": "76bfdc3d-7185-4c9d-a520-527574e23f25",
"name": "Sample Form",
"description": "Sample Form",
"color": "#00ff55",
"image": "https://public-file.tatodesk.net/general/file?file=979b2d33-23c9-4d3f-934f-7ac020b41d74",
"scale": "scale_one_to_ten",
"isActive": 1,
"isDeleted": 2,
"userID": 4405,
"accountID": 241,
"responseFlowType": "full",
"createdAt": "2025-10-17T08:33:32.214Z",
"updatedAt": "2025-10-17T08:33:32.214Z",
"questions": [
{
"surveyFormQuestionID": "c800a3a9-1d31-43fd-a8dc-d70bb8fc620d",
"question": "What is your rating for our service?",
"questionType": "check",
"weight": 1,
"textRates": null,
"isRequired": 1,
"sort": 1,
"scale": "scale_one_to_five",
"isDeleted": 2,
"surveyFormID": "76bfdc3d-7185-4c9d-a520-527574e23f25",
"options": [
{
"surveyFormQuestionOptionID": "9e54ca0e-b640-454a-813a-0c0ab962dde1",
"option": "😡 Bad",
"rate": 1,
"sort": 1,
"isDeleted": 2,
"surveyFormQuestionID": "c800a3a9-1d31-43fd-a8dc-d70bb8fc620d"
},
{
"surveyFormQuestionOptionID": "abd6ccf0-47fc-4b6c-9a62-b0333a8c8a88",
"option": "😕 Fair",
"rate": 2,
"sort": 2,
"isDeleted": 2,
"surveyFormQuestionID": "c800a3a9-1d31-43fd-a8dc-d70bb8fc620d"
},
{
"surveyFormQuestionOptionID": "99aec891-ada3-480d-88be-4521c50782e7",
"option": "😐 Average",
"rate": 3,
"sort": 3,
"isDeleted": 2,
"surveyFormQuestionID": "c800a3a9-1d31-43fd-a8dc-d70bb8fc620d"
},
{
"surveyFormQuestionOptionID": "c0dcf185-e10c-41ba-862d-1bc96a3ded47",
"option": "😊 Good",
"rate": 4,
"sort": 4,
"isDeleted": 2,
"surveyFormQuestionID": "c800a3a9-1d31-43fd-a8dc-d70bb8fc620d"
},
{
"surveyFormQuestionOptionID": "5826429b-6604-487e-be07-7218d06e8775",
"option": "🤩 Excellent",
"rate": 5,
"sort": 5,
"isDeleted": 2,
"surveyFormQuestionID": "c800a3a9-1d31-43fd-a8dc-d70bb8fc620d"
}
],
"formatPreviewOptions": "vertical"
},
{
"surveyFormQuestionID": "5d131fda-0181-4c08-8295-1e62ff572561",
"question": "Which of the reasons below apply to your contact today?",
"questionType": "check",
"weight": 1,
"textRates": null,
"isRequired": 1,
"sort": 2,
"scale": "scale_one_to_five",
"isDeleted": 2,
"surveyFormID": "76bfdc3d-7185-4c9d-a520-527574e23f25",
"options": [
{
"surveyFormQuestionOptionID": "862f18e2-38e7-463c-b0c3-1d88bc86bfd5",
"option": "💧 Water outage",
"rate": 1,
"sort": 1,
"isDeleted": 2,
"surveyFormQuestionID": "5d131fda-0181-4c08-8295-1e62ff572561"
},
{
"surveyFormQuestionOptionID": "36d3f5d0-0dc9-4c7a-9970-9b7820f61838",
"option": "💡 Bill / Invoice",
"rate": 2,
"sort": 2,
"isDeleted": 2,
"surveyFormQuestionID": "5d131fda-0181-4c08-8295-1e62ff572561"
},
{
"surveyFormQuestionOptionID": "070ee2f4-c611-4e69-8cec-d6da8dc0caa4",
"option": "🧾 Duplicate copy",
"rate": 3,
"sort": 3,
"isDeleted": 2,
"surveyFormQuestionID": "5d131fda-0181-4c08-8295-1e62ff572561"
},
{
"surveyFormQuestionOptionID": "f09f8747-3423-4732-954f-c3b6c82d97b3",
"option": "🔧 Maintenance",
"rate": 4,
"sort": 4,
"isDeleted": 2,
"surveyFormQuestionID": "5d131fda-0181-4c08-8295-1e62ff572561"
},
{
"surveyFormQuestionOptionID": "9b008637-a345-48c1-aa1b-fa97a0aa3d1d",
"option": "📝 Others",
"rate": 5,
"sort": 5,
"isDeleted": 2,
"surveyFormQuestionID": "5d131fda-0181-4c08-8295-1e62ff572561"
}
],
"formatPreviewOptions": "vertical"
},
{
"surveyFormQuestionID": "2c4f2484-d530-47fc-9274-68487eaf796e",
"question": "What is your suggestion/complaint for our service?",
"questionType": "text",
"weight": 1,
"textRates": [
{
"rate": 1,
"description": "What is your suggestion/complaint for our service?"
}
],
"isRequired": 1,
"sort": 3,
"scale": "scale_one_to_ten",
"isDeleted": 2,
"surveyFormID": "76bfdc3d-7185-4c9d-a520-527574e23f25",
"options": [],
"formatPreviewOptions": ""
}
],
"footer": "tatodesk",
"finalMessage": "Thank you for rating us",
"shortID": "59rWwm6",
"tagIDs": []
}
}
```
{% endcode %}
#### POST Register form answers
{% code lineNumbers="true" %}
```typescript
https://api.tatodesk.com/survey/v1/registerSurveyAnswer
```
{% endcode %}
**Description:**\
This request registers the answers provided by a user in a survey form.\
It sends both the form identification information and the set of filled questions and answers.
**Request Example:**
{% code lineNumbers="true" %}
```json
curl --location 'https://api.tatodesk.com/survey/v1/registerSurveyAnswer' \
--header 'TATODESK-API-KEY: {{surveyApiKEy}}' \
--data '{
"surveyFormID": "76bfdc3d-7185-4c9d-a520-527574e23f25",
"referenceDate": "10102025",
"requestDate": "10102025",
"answers": {
"answers": [
{
"question": "What is your rating for our service?",
"answerText": "🤩 Excellent",
"answerValue": 5,
"questionType": "check",
"scaleQuestion": "scale_one_to_five",
"weightQuestion": 1,
"surveyFormQuestionID": "c800a3a9-1d31-43fd-a8dc-d70bb8fc620d",
"surveyFormQuestionOptionID": "5826429b-6604-487e-be07-7218d06e8775"
},
{
"question": "Which of the reasons below apply to your contact today?",
"answerText": "📝 Others",
"answerValue": 5,
"questionType": "check",
"scaleQuestion": "scale_one_to_five",
"weightQuestion": 1,
"surveyFormQuestionID": "5d131fda-0181-4c08-8295-1e62ff572561",
"surveyFormQuestionOptionID": "9b008637-a345-48c1-aa1b-fa97a0aa3d1d"
},
{
"question": "What is your suggestion/complaint for our service?",
"answerText": "Service could be more humanized.",
"answerValue": 1,
"questionType": "text",
"scaleQuestion": "scale_one_to_five",
"weightQuestion": 1,
"surveyFormQuestionID": "2c4f2484-d530-47fc-9274-68487eaf796e"
}
]
}
}
'
```
{% endcode %}
**Response Example:**
{% code lineNumbers="true" %}
```json
{
"error": null
}
```
{% endcode %}
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://portal.tatodesk.com/tato-docs-en/technical-documentation/tatodesk-api.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.