Documentação da API

O mapa definitivo para integrar o seu sistema ao Contele Teams.

Dicionário de Endpoints

Antes de começarmos a mapear, entenda como chamamos cada recurso dentro da nossa API:

POIS
(Locais)

PORTIFOLIOS
(Carteiras)

REFUNDS
(Reembolso)

TASKS
(Visitas)

USERS
(Usuários)

CATEGORIES
(Categorias)

FORMS
(Formulários)

POIS (Locais)

Parâmetro	Tipo de Dado	Utilização (Métodos)	Descrição
createdAt	String	GET POST	Data de criação do Local
updatedAt	String	GET POST	Data da última atualização do Local
id	String	GET POST	ID único do Local
customId	String	GET POST	ID customizado do Local
name	String	GET POST	Nome Fantasia do Local
portfolios	Array [String]	GET POST	Carteiras que o Local está inserido
corporateName	String	GET POST	Razão Social do Local
cnpj_cpf	String	GET POST	Documento do Local
lat	Number (Float)	GET POST	Latitude do endereço do Local
lng	Number (Float)	GET POST	Longitude do endereço do Local
status	String	GET POST	Status do Local (Válido, Geoposicionado…)
creatorName	String	GET	Nome do criador do Local
clientId	String	GET	ID da sua conta no sistema
address	Object	GET POST	Endereço
∟ neighborhood	String	GET POST	Bairro
∟ street	String	GET POST	Logradouro
∟ state	String	GET POST	Estado
∟ zipcode	String	GET POST	CEP
∟ number	String	GET POST	Número
∟ complement	String	GET POST	Complemento
∟ city	String	GET POST	Cidade
contacts	Array [Object]	GET POST	Contatos
∟ name	String	GET POST	Nome do Contato
∟ phone	String	GET POST	Telefone do Contato
∟ email	String	GET POST	E-mail do Contato
categoryId	String	GET POST	ID da Categoria do Local
obs	String	GET POST	Observações do Local
poiIDs	Array [String]	DELETE	ID’s dos Locais

Exemplo JSON & Métodos

GET/pois POST/pois GET/pois/{poiID} PUT/pois/{poiID} DELETE/pois/batch

{
    "pois": [
        {
            "id": "cce66b8e-5d89-49c3-9171-...",
            "name": "Contele",
            "obs": "visitar somente à tarde",
            "corporateName": "Contele Soluções",
            "cnpj_cpf": 43534554534,
            "address": {
                "city": "São Bernardo do Campo",
                "state": "SP",
                "street": "Avenida Getúlio Vargas",
                "zipcode": "09751-251"
            },
            "contacts": [
                {
                    "name": "Douglas",
                    "email": "douglas.vichi@contele.com",
                    "phone": "13974151309"
                }
            ]
        }
    ]
}

PORTIFOLIOS (Carteiras)

Parâmetro	Tipo de Dado	Utilização	Descrição
id	String	GET	ID da Carteira
name	String	GET	Nome da Carteira
portifoliosIds	String	PUT DELETE	ID’s das Carteiras
poisIds	String	PUT DELETE	ID’s dos Locais na Carteira

Exemplo JSON & Métodos

GET/portifolios PUT/portifolios DELETE/portifolios GET/portifolios/{id}/pois

{
    "id": "c5d71bb3-8ea3-44b3-acca-fa1b5e1c4714",
    "name": "Carteira do funcionario Natalia Silva"
}

REFUNDS (Reembolso Avulso)

Parâmetro	Tipo de Dado	Utilização	Descrição
page	String	GET	Paginação dos Reembolsos Avulsos
perPage	String	GET	Itens por Paginação
refunds	Array	GET	Agrupamento de Reembolsos Avulsos
id	String	GET PUT	ID do Reembolso Avulso
value	Number	GET POST	Valor do Lançamento
state	String	GET POST PUT	Situação do Lançamento
date	String	GET POST	Data do Lançamento
type	String	GET POST	Tipo de Lançamento
userId	String	GET POST	ID do Usuário do Lançamento
currency	String	GET POST	Moeda do Lançamento
paymentDate	String	GET POST PUT	Data para status Pago
refundType	String	GET POST	Tipo (Reembolsável vs Não Reembolsável)
taskId	String	GET POST	ID da Visita vinculada ao Lançamento
poiID	String	GET POST	ID do Local vinculado ao Lançamento

Exemplo JSON & Métodos

GET/refunds GET/refunds/{refundId} POST/refunds PUT/refunds/{refundId}

{
    "id": "e9e98a2c-ad49-4447-a58b-c245dd93c8e0",
    "value": 200,
    "date": "2026-03-17T00:00:00.000Z",
    "state": "accepted",
    "type": "accommodation",
    "userId": "746d4113-e351-4344-a512-...",
    "currency": "BRL",
    "refundType": "non_refundable",
    "poiId": null,
    "taskId": null
}

REFUNDS (Reembolso KM)

Parâmetro	Tipo de Dado	Utilização	Descrição
page	String	GET	Paginação dos Reembolsos Avulsos
perPage	String	GET	Itens por Paginação
refunds	Array	GET	Agrupamento de Reembolsos
id	String	GET	ID do Reembolso
value	Number	GET	Valor do Lançamento
date	String	GET	Data do Reembolso
userId	String	GET	ID do Usuário
coefficient	Number	GET	Valor do coeficiente de multiplicação
kilometers	Number	GET	Quilômetros percorridos
companyCar	Boolean	GET	Veículo utilizado é reembolsável
taskIds	String	GET	ID da Visita vinculada ao Lançamento
ignoredTasks	String	GET	ID do Local vinculado ao Lançamento
calculating	Boolean	GET	Cálculo em andamento do reembolso
createdAt	String	GET	Data da criação do Reembolso
updatedAt	String	GET	Data da atualização do Reembolso
endRoute	Array	GET	Endereço do ponto final da rota
startRoute	Array	GET	Endereço do ponto inicial da rota

Exemplo JSON & Métodos

GET/refunds/km GET/refunds/km/{refundId}

{
    "page": 1,
    "perPage": 1,
    "refunds": [
        {
            "calculating": false,
            "coefficient": 1,
            "companyCar": false,
            "date": "2025-11-14T00:00:00.000Z",
            "kilometers": 0,
            "startRoute": {
                "name": "Casa do Usuário",
                "address": {
                    "neighborhood": "Parque Enseada",
                    "city": "Guarujá"
                }
            }
        }
    ]
}

TASKS (Visitas)

Parâmetro	Tipo de Dado	Utilização	Descrição
createdAt	String	GET POST	Data da criação da Visita
updatedAt	String	GET POST	Data de atualização da Visita
id	String	GET	ID da Visita
poiId	String	GET POST	ID do Local da Visita
customPoiId	String	GET POST	ID Customizado do Local da Visita
customId	String	GET POST	ID Customizado da Visita
userId	String	GET POST	ID do Usuário da Visita
timezone	String	GET POST	Fuso Horário da Visita
datetime	String	GET POST	Data e Hora da Visita
withTime	Boolean	GET POST	Visita com horário (Verdadeiro ou Falso)
foreignOs	String	GET POST	Número da OS personalizada
status	String	GET POST	Status da Visita
checkoutTime	String	GET POST	Data e Hora do Check-Out
checkinTime	String	GET POST	Data e Hora do Check-In
observation	String	GET POST	Observação da Visita
comments	String	GET POST	Comentários da Visita
justification	String	GET POST	Justificativa da Recusa da Visita
os	String	GET POST	Número da OS
photos	String	GET POST	Links das Fotos da OS
originalDate	String	GET	Data original do agendamento
rescheduled	Boolean	GET	Visita reagendada (Verdadeiro ou Falso)
poi	Array	GET	Local da Visita
∟ createdAt	String	GET	Data de Criação do Local da Visita
∟ updatedAt	String	GET	Data de Atualização do Local da Visita
∟ id	String	GET	ID do Local da Visita
∟ customId	String	GET	ID Customizado do Local da Visita
∟ name	String	GET	Nome do Local da Visita
∟ corporateName	String	GET	Razão Social do Local da Visita
∟ cnpj_cpf	String	GET	Documento do Local da Visita
∟ lat	Number	GET	Latitude do Local da Visita
∟ lng	Number	GET	Longitude do Local da Visita
∟ status	String	GET	Status do Local da Visita
address	Array	GET	Endereços do Local
∟ neighborhood	String	GET	Bairro do Local da Visita
∟ street	String	GET	Logradouro do Local da Visita
∟ state	String	GET	Estado do Local da Visita
∟ zipcode	String	GET	CEP do Local da Visita
∟ number	String	GET	Número do Local da Visita
∟ complement	String	GET	Complemento do Local da Visita
∟ city	String	GET	Cidade do Local da Visita
contacts	Array	GET	Contatos do Local
∟ name	String	GET	Contato do Local da Visita
∟ phone	String	GET	Telefone do Local da Visita
∟ email	String	GET	E-mail do Local da Visita
categoryId	String	GET	ID da Categoria da Visita
categoryName	String	GET	Nome da Categoria da Visita
categoryColor	String	GET	Cor da Categoria da Visita (Hex)
deleted_taks_ids	String	DELETE	ID’s das Visitas a serem deletadas

Exemplo JSON & Métodos

GET/tasks POST/tasks GET/tasks/{taskId} PUT/tasks/{taskId} POST/tasks/{id}/reschedule DELETE/tasks/delete_tasks

{
    "id": "a7cad09a-7254-467c-9583-d61b856ffa89",
    "userId": "d09fe198-9da2-4139-9566...",
    "poiId": "8df0624f-7602-4c98-ab44...",
    "datetime": "2026-03-24T03:00:00.000Z",
    "withTime": false,
    "status": "pendente",
    "os": "26550",
    "poi": {
        "name": "100083714 - LOTERICA...",
        "corporateName": "LOTERICA...",
        "address": {
            "city": "Santos",
            "state": "SP",
            "street": "Rua Euclides da Cunha"
        }
    }
}

USERS (Usuários)

Parâmetro	Tipo de Dado	Utilização	Descrição
id	String	GET	ID do Usuário
name	String	GET	Nome do Usuário
username	String	GET	E-mail do Usuário
document	String	GET	Documento do Usuário
location	Array	GET	Geolocalização da casa do Usuário
∟ latitude	String	GET	Latitude da casa do Usuário
∟ longitude	String	GET	Longitude da casa do Usuário
∟ lastUpdate	String	GET	Última atualização
portifolios	Array	GET	Carteiras do Usuário
∟ id	String	GET	ID da Carteira do Usuário
∟ name	String	GET	Nome da Carteira do Usuário
address	Array	GET	Agrupamento do endereço do Usuário
∟ neighborhood	String	GET	Bairro da casa do Usuário
∟ street	String	GET	Logradouro da casa do Usuário
∟ state	String	GET	Estado da casa do Usuário
∟ zipcode	String	GET	CEP da casa do Usuário
∟ number	String	GET	Número da casa do Usuário
∟ city	String	GET	Cidade da casa do Usuário

Exemplo JSON & Métodos

GET/users

{
    "id": "15ea192e-a9e0-4c22-ab2f...",
    "name": "Douglas Vichi",
    "document": "43543534534",
    "username": "douglas.vichi@contele.com.br",
    "location": {
        "latitude": "-23.9749213,",
        "longitude": "-46.3079892",
        "lastUpdate": ""
    },
    "address": {
        "neighborhood": "Aparecida",
        "street": "Rua Luiz Marques Gaspar",
        "state": "SP",
        "zipcode": "11040-040",
        "city": "Santos"
    },
    "portifolios": []
}

CATEGORIES (Categorias)

Parâmetro	Tipo de Dado	Utilização	Descrição
id	String	GET	ID da Categoria
name	String	GET	Nome da Categoria
clientId	String	GET	ID da sua conta no sistema
color	String	GET	Código da Cor da Categoria (Hex)
updatedAt	String	GET	Data da última atualização da Categoria
createdAt	String	GET	Data da criação da Categoria

Exemplo JSON & Métodos

GET/categories

"data": [
    {
        "id": "207572",
        "name": "Visita Técnica",
        "clientId": "234d17c9-1fa0-44e5...",
        "color": "#1abc9c",
        "updatedAt": "2025-03-14T12:40:28.968Z",
        "createdAt": "2025-03-14T12:40:16.659Z"
    }
]

FORMS (Templates de Formulários)

Parâmetro	Tipo de Dado	Utilização	Descrição
page	Integer	GET	Página a ser recuperada.
per_page	Integer	GET	Número de itens por página.
status	String	GET	Status dos templates
add_users_information_to_form_template	Boolean	GET	Inclui informações de usuários no template.

Exemplo JSON & Métodos

GET/api/v1/list-forms-templates

{
  "forms_templates": [
    {
      "id": "f9ba9bd1-3fd4-42f0-b680...",
      "template_name": "Descrição interna",
      "template_status": "active",
      "template_public": false,
      "segments": [
        {
          "type": "section",
          "title": "Descrição de uso interno"
        }
      ],
      "users": [
        {
          "name": "Ariane",
          "email": "tecnica5@engefood.com.br"
        }
      ]
    }
  ]
}

FORMS (Listagem de Formulários)

Parâmetro	Tipo de Dado	Utilização	Descrição
add_templates_information_to_form	Boolean	GET	Inclui informações de templates no form
add_pois_information_to_form	Boolean	GET	Inclui informações de POIs no form
add_tasks_information_to_form	Boolean	GET	Inclui informações de tarefas no form
add_users_information_to_form	Boolean	GET	Inclui informações de usuários no form
only_forms_with_answers	Boolean	GET	Filtra apenas formulários com respostas
templates_ids	String	GET	IDs dos templates separados por vírgula
linked_urns	String	GET	ID das tarefas no formato v0:cge:task...
start_date	String	GET	Data de início no formato ISO8601
end_date	String	GET	Data de término no formato ISO8601
page	String	GET	Página de resultados
per_page	String	GET	Número de resultados por página

Exemplo JSON & Métodos

GET/api/v1/list-forms

{
  "forms": [
    {
      "form_id": "123",
      "template_information": {...},
      "pois_information": {...},
      "tasks_information": {...},
      "users_information": {...},
      "answers": [...]
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 100,
    "total_pages": 10,
    "total_items": 1000
  }
}

Onde encontrar a Chave API

Siga os passos abaixo dentro do sistema Contele Teams para localizar suas credenciais:

1

Menu de Integração

No Contele Teams, acesse Configurações > Integração. Na sequência, selecione a opção "Usar API Rest". Importante: É preciso ter acesso ao Contele Teams para acessar chaves de integração.

2

Gerenciamento de Chaves

Logo abaixo você será direcionado para as orientações, podendo visualizar, copiar ou gerar novas chaves (Token e X-API-KEY).

Como testar no Swagger

O Swagger é a nossa ferramenta oficial para você visualizar e testar as requisições antes de programar.

Passo a Passo

Expanda o Endpoint desejado e clique em "Try it out".
Insira as chaves Authorization e X-API-KEY.
Insira os parâmetros de query obrigatórios (se houver).
Clique em Execute.
Copie o Curl gerado e aplique em sua requisição (Ex: Postman) para testar!

Acessar Swagger