Português (BR)
PortalCentral de ajudaDesenvolvimentoAPI
Atendimentos - Pesquisa
Autor
Agidesk
Importante
O consumo de nossa API possui um limite de 10 requisições por minuto, garantindo um
comportamento saudável em sua utilização. Caso sua empresa tenha um cenário
específico que exija um aumento de uso, entre em contato com o nosso time de
atendimento para análise de viabilidade.
Parâmetros do tipo <list> aceitam múltiplos valores, tanto do tipo text separado por vírgula '1,2,3'
quanto do tipo array [1,2,3]
Método:
POST
URL:
[Link]
Headers:
Content-Type: application/x-www-form-urlencoded
X-Tenant-ID: <sua_conta>
Authorization: Bearer <access_token> (Desenvolvimento > API > Autenticação)
Body:
scope: <text> (contact | agent)
(Define se deve listar os atendimentos onde o usuário é o contato "contact", ou onde é o
responsável "agent". Usuários que são somente contato, são definidos como "contact" por
padrão)
length: <integer>
(Define a quantidade de registros a serem retornados. A quantidade máxima é 100. Se vazio,
retornará 10 registros por página. Exemplo: 'length=25')
start: <integer>
(Define a partir de qual registro deve iniciar a listagem (Em uma paginação de 10 registros por
página, informar 10 para a segunda página, 20 para a terceita, 30 para a quarta, etc). Se vazio,
retornará a partir do registro 0. Exemplo: 'start=50')
sorting: <list> (id | title | fulltitle | slug | initials | icon | color | subtitle | abstract | content |
htmlcontent | active | default | new | order | system | status_id | type_id | privacy_id | related_id |
company_id | parent_id | created_at | created_by | updated_at | updated_by | deleted_at |
deleted_by | duedate | priority_id | responsible_id | team_id | responsedate | started_at |
finished_at | startduration | finishduration | totalduration | absstartduration | absfinishduration |
abstotalduration | sla_id | closure_id | tasktemplate_id | cronjob_id | queuedjob_id | template_id |
module_id | inboundemail_id | notificationgroup_id | hash | emailaccount_id | tasksource_id)
(Define a ordem dos registros a serem retornados. Para ordem decrescente, utilizar um "-"
(menos) antes do parâmetro. Se vazio, retornará ordenado pelo "id" decrescente. Exemplo:
'sorting=-id')
fields: <list> (id | title | fulltitle | slug | initials | icon | color | subtitle | abstract | content |
htmlcontent | active | default | new | order | system | status_id | type_id | privacy_id | related_id |
company_id | parent_id | created_at | created_by | updated_at | updated_by | deleted_at |
deleted_by | duedate | priority_id | responsible_id | team_id | responsedate | started_at |
finished_at | startduration | finishduration | totalduration | absstartduration | absfinishduration |
abstotalduration | sla_id | closure_id | tasktemplate_id | cronjob_id | queuedjob_id | template_id |
module_id | inboundemail_id | notificationgroup_id | hash | emailaccount_id | tasksource_id |
factdescription | causedescription | actiondescription | module | contact | customer | service | type
| priority | searchtitle | lists | follower | team | customers | contacts | services | approvers)
(Define os campos a serem retornados. Se vazio, retornará todos. Exemplo:
'id,title,priority,team,customers')
active: <boolean> (0 | 1)
(Define se deve exibir apenas atendimentos abertos, ou seja, não retornar encerrados e
cancelados)
status: <list> (GET [Link]
type: <list> (GET [Link]
forecast: <text> (all | myaction | today | tomorrow | week | late | teams | inbox | customerresponse
| waitingcustomer | waitingprovider | approvalresponse | waitingapproval | myapproval)
(Define um filtro de situação de acordo com a previsão ou status dos atendimentos)
periodfield: <text> (created_at | updated_at | started_at | finished_at | responsedate | duedate)
(Define sobre qual campo de data os filtros deverão ser aplicados)
initialdate: <datetime> YYYY-mm-dd HH:ii:ss (define a partir de qual data os resultados deverão
partir)
finaldate: <datetime> YYYY-mm-dd HH:ii:ss (define até qual data os resultados deverão ser
filtrados)
OU
period: <text> (today | yesterday | thisweek | lastweek | thismonth | lastmonth | thisyear | lastyear
| last7days | last15days | last30days | last60days | last90days | last12months | alltimes | 7days |
15days | 30days | 60days | 90days | 12months)
(Define um período específico para filtro de data)
responsible: <list> (GET [Link]
team: <list> (GET [Link]
title: <text>
content: <text>
priority: <list> (GET [Link]
customer: <list> (GET [Link]
contact: <list> (GET [Link]
department: <list> (GET [Link]
costcenter: <list> (GET [Link]
businessunit: <list> (GET [Link]
department: <list> (GET [Link]
service: <list> (GET [Link]
tag: <list> (GET [Link]
responsedate: <date> (Formato: YYYY-mm-dd)
duedate: <date> (Formato: YYYY-mm-dd)
created_at: <date> (Formato: YYYY-mm-dd)
updated_at: <date> (Formato: YYYY-mm-dd)
customfield: <formfield_id 1> <operator 1> <value 1>, <formfield_id 2> <operator 2> <value 2>,
<formfield_id 3> <operator 3> <value 3>
Operadores:
eq (igual)
ne (diferente)
gt (maior que)
ge (maior ou igual)
lt (menor que)
le (menor ou igual)
isnull (valores vazios, para esse caso não precisa do 3º atributo <value>)
notnull (valores não vazios, para esse caso não precisa do 3º atributo <value>)
Exemplo: customfield=35 le 2022-01-01 00:00:00, 48 eq problema
Response:
"id": "804",
"title": "Title",
"fulltitle": "Fulltitle",
"slug": "title",
"initials": null,
"icon": null,
"color": null,
"subtitle": null,
"abstract": null,
"content": "Content",
"htmlcontent": "htmlcontent",
"active": "1",
"default": "0",
"new": 0,
"order": "613",
"system": "0",
"status_id": "5",
"type_id": null,
"privacy_id": null,
"related_id": null,
"company_id": "0",
"parent_id": null,
"created_at": "2020-03-12 23:29:58",
"created_by": "0",
"updated_at": "2020-03-12 23:29:59",
"updated_by": "0",
"deleted_at": null,
"deleted_by": null,
"duedate": "2020-03-16 16:00:00",
"priority_id": "81",
"responsible_id": null,
"team_id": "0",
"responsedate": "2020-03-13 17:00:00",
"started_at": null,
"finished_at": null,
"startduration": null,
"finishduration": null,
"totalduration": null,
"absstartduration": null,
"absfinishduration": null,
"abstotalduration": null,
"sla_id": "7",
"closure_id": null,
"tasktemplate_id": null,
"cronjob_id": null,
"queuedjob_id": null,
"template_id": null,
"module_id": "1",
"inboundemail_id": null,
"notificationgroup_id": "54",
"hash": "5e6af02636754_T000",
"emailaccount_id": null,
"tasksource_id": "1",
"factdescription": null,
"causedescription": null,
"actiondescription": null,
"module": "issues",
"contact": "José Silva",
"customer": "Demonstração Agidesk",
"service": "Abertura",
"type": null,
"priority": "Alta",
"searchtitle": "searchtitle",
"lists": [],
"follower": 0,
"team": {
"id": "67",
"title": "Desenvolvimento",
"fulltitle": "Desenvolvimento",
"slug": "desenvolvimento",
"initials": null,
"icon": null,
"color": null,
"active": "1",
"default": "0",
"new": "1",
"order": "3",
"system": "0",
"status_id": null,
"type_id": null,
"privacy_id": null,
"related_id": null,
"company_id": "0",
"parent_id": null,
"created_at": "2019-03-07 11:07:44",
"created_by": "0",
"updated_at": "2019-05-27 10:16:44",
"updated_by": "0",
"deleted_at": null,
"deleted_by": null,
"description": "",
"monthlyfee": "2400.00",
"hourlyrate": "80.00",
"monthlyhours": "108000.00",
"avatar": {
"id": "58",
"path": "/uploads/49/avatars/2019/03/3845914771/[Link]"
},
"customers": {
"2383": {
"id": "2383",
"title": "Demonstração Agidesk",
"fulltitle": "Demonstração Agidesk",
"slug": "demonstracaoagidesk",
"initials": null,
"icon": null,
"color": "#3F3E4E",
"active": "1",
"default": "0",
"new": "1",
"order": "269",
"system": "0",
"status_id": "2",
"type_id": "2",
"related_id": null,
"company_id": "49",
"parent_id": null,
"created_at": "2019-09-06 16:19:29",
"created_by": "50",
"updated_at": "2020-04-13 10:59:31",
"updated_by": "50",
"deleted_at": null,
"deleted_by": null,
"fullname": "Demonstração Agidesk",
"step": "completed",
"code": "001.204.201.0001/40",
"statecode": "",
"citycode": "",
"email": "",
"phone": "",
"cellphone": "",
"size_id": "2",
"featured": "0",
"description": "",
"billing": "0.00",
"expirationdate": null,
"referencecompany_id": "49",
"responsible_id": "50",
"monthlyfee": null,
"hourlyrate": null,
"monthlyhours": null,
"phoneextension": "",
"notificationgroup_id": null,
"contractnotificationgroup_id": "82",
"contractduedays": null,
"contractpastduedays": null,
"fee": 0,
"duedate": null,
"billingduedate": null,
"avatar": []
}
},
"contacts": {
"51": {
"id": "51",
"title": "José Silva",
"fulltitle": "José Silva",
"slug": "josesilva",
"initials": null,
"icon": null,
"color": null,
"active": "1",
"default": "0",
"new": "1",
"order": "29",
"system": "0",
"parent_id": null,
"created_at": "2019-03-07 11:09:53",
"created_by": "50",
"updated_at": "2020-02-20 09:59:04",
"updated_by": "51",
"deleted_at": null,
"deleted_by": null,
"firstname": "José",
"middlename": "",
"lastname": "Silva",
"email": "suporte@[Link]",
"status_id": "2",
"type_id": null,
"genre_id": null,
"username": "josesilva",
"step": "tour",
"phone": "",
"cellphone": "",
"description": "",
"birthday": null,
"fullname": "José Silva",
"authorname": "SILVA, José ",
"customers": [
"id": "2383",
"title": "Demonstração Agidesk",
"slug": "demonstracaoagidesk",
"_out": "2383",
"_in": "51",
"relation_id": "27903",
"active": "1",
"default": "0",
"new": "1",
"order": "19",
"created_by": "51",
"created_at": "2020-02-09 20:14:54",
"updated_by": "51",
"updated_at": "2020-02-09 20:14:54",
"avatar": [],
"banner": []
],
"emailtitle": "José Silva <suporte@[Link]>",
"searchtitle": "José Silva (Demonstração Agidesk)",
"contacttitle": "José Silva (Demonstração Agidesk) <suporte@[Link]> ",
"contactstatus_id": "2",
"externalcode": null,
"blocked": "0",
"phoneextension": null,
"preferences": null,
"avatar": {
"id": "63",
"path": "/uploads/49/avatars/2019/03/704583792/[Link]"
},
"services": {
"592": {
"id": "592",
"title": "Abertura",
"fulltitle": "Abertura",
"slug": "abertura",
"initials": null,
"icon": null,
"color": null,
"subtitle": "",
"abstract": "",
"content": "",
"htmlcontent": "",
"active": "1",
"default": "0",
"new": "1",
"order": "89",
"system": "0",
"status_id": "2",
"type_id": null,
"privacy_id": "1",
"related_id": null,
"company_id": "49",
"parent_id": null,
"created_at": "2019-08-30 16:50:36",
"created_by": "50",
"updated_at": "2020-03-11 18:20:04",
"updated_by": "50",
"deleted_at": null,
"deleted_by": null,
"featured": "1",
"featuredorder": null,
"priority_id": null,
"team_id": "67",
"issuetype_id": null,
"survey_id": "6",
"board_id": null,
"requireclosure": "1",
"tasktype_id": null,
"taskpriority_id": null,
"form_id": "11",
"requirefca": null,
"requirefact": "1",
"requirecause": "1",
"requireaction": "1",
"topics": {
"41": {
"id": "41",
"title": "Dúvidas",
"fulltitle": "Suporte > Dúvidas",
"slug": "duvidas",
"initials": null,
"icon": null,
"color": null,
"subtitle": null,
"abstract": null,
"content": "",
"htmlcontent": null,
"active": "1",
"default": "0",
"new": "1",
"order": "11",
"system": "0",
"status_id": null,
"type_id": null,
"privacy_id": "1",
"related_id": null,
"company_id": "49",
"parent_id": null,
"created_at": "2019-03-07 12:39:53",
"created_by": "50",
"updated_at": "2020-03-11 18:21:02",
"updated_by": "50",
"deleted_at": null,
"deleted_by": null,
"management_id": "1",
"featured": "1",
"featuredorder": null,
"priority_id": null,
"team_id": null,
"issuetype_id": null,
"survey_id": null,
"board_id": null,
"requireclosure": "0",
"tasktype_id": null,
"taskpriority_id": null,
"form_id": "9",
"requirefca": null,
"requirefact": "0",
"requirecause": "0",
"requireaction": "0",
"privacy": {
"id": "1",
"title": "Geral",
"fulltitle": null,
"slug": "public",
"initials": null,
"icon": "globe",
"color": null,
"active": "1",
"default": "0",
"new": "1",
"order": null,
"system": "1",
"status_id": null,
"type_id": null,
"related_id": null,
"company_id": null,
"parent_id": null,
"created_at": "2018-10-25 17:09:54",
"created_by": null,
"updated_at": null,
"updated_by": null,
"deleted_at": null,
"deleted_by": null
},
"categories": {
"27": {
"id": "27",
"title": "Suporte",
"fulltitle": "Suporte",
"slug": "suporte",
"initials": null,
"icon": null,
"color": null,
"subtitle": null,
"abstract": null,
"content": "",
"htmlcontent": null,
"active": "1",
"default": "0",
"new": "1",
"order": "2",
"system": "0",
"privacy_id": "1",
"related_id": null,
"company_id": "49",
"parent_id": null,
"created_at": "2019-03-07 11:42:06",
"created_by": "50",
"updated_at": "2019-10-21 23:41:40",
"updated_by": "50",
"deleted_at": null,
"deleted_by": null,
"featured": "1",
"featuredorder": null,
"management_id": "1",
"priority_id": "53",
"team_id": "65",
"issuetype_id": null,
"survey_id": "5",
"board_id": null,
"requireclosure": "0",
"tasktype_id": null,
"taskpriority_id": "81",
"form_id": null,
"requirefca": null,
"requirefact": null,
"requirecause": null,
"requireaction": null
},
"form": {
"id": "9",
"title": "Cadastro de usuários",
"fulltitle": "Cadastro de usuários",
"slug": "cadastro-de-usuarios",
"initials": null,
"icon": null,
"color": null,
"active": "1",
"default": "0",
"new": "1",
"order": "1",
"system": "0",
"status_id": null,
"type_id": null,
"related_id": null,
"company_id": "49",
"created_at": "2020-02-02 17:41:36",
"created_by": "50",
"updated_at": "2020-03-11 19:27:46",
"updated_by": "50",
"deleted_at": null,
"deleted_by": null,
"module_id": "1",
"size_id": "3",
"module": {
"id": "1",
"title": "Atendimentos",
"fulltitle": null,
"slug": "issues",
"initials": null,
"icon": null,
"color": null,
"active": "1",
"default": "0",
"new": "1",
"order": null,
"system": "1",
"related_id": null,
"company_id": null,
"created_at": "2018-12-14 19:55:25",
"created_by": null,
"updated_at": null,
"updated_by": null,
"deleted_at": null,
"deleted_by": null,
"report": "0",
"email": "1",
"form": "1",
"customform": "1",
"stakeholder": "0"
},
"size": {
"id": "3",
"title": "Modal médio (50%)",
"fulltitle": null,
"slug": "small",
"initials": null,
"icon": null,
"color": null,
"active": "1",
"default": "0",
"new": "1",
"order": null,
"system": "1",
"related_id": null,
"company_id": null,
"created_at": "2020-02-02 13:26:35",
"created_by": null,
"updated_at": null,
"updated_by": null,
"deleted_at": null,
"deleted_by": null
},
"topics": {
"6": {
"id": "6",
"title": "Novidades",
"fulltitle": "Formulários > Novidades",
"slug": "novidades",
"initials": null,
"icon": null,
"color": null,
"active": "1",
"default": "0",
"new": "1",
"order": "2",
"system": "0",
"related_id": null,
"company_id": "49",
"created_at": "2020-03-11 19:27:38",
"created_by": "50",
"updated_at": "2020-03-11 19:27:39",
"updated_by": "50",
"deleted_at": null,
"deleted_by": null
},
"servicecategories": [],
"fullservice": "Suporte > Dúvidas > Abertura",
"searchtitle": "Abertura (Suporte > Dúvidas)",
"type": [],
"privacy": [],
"status": [],
"favorite": 0,
"form": []
},
"approvers": "50,52,82,85,1879,13370",
"forbidden": false
Compartilhe
[Link]
Este artigo foi útil para você?
Este artigo ainda não recebeu avaliações positivas
Copyright © 2025 Agidesk. Todos os direitos reservados.