{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"5ff9a15e-f3ed-424f-b4b8-c2f6db7196d4","name":"API Minha Visita — Visão Geral","description":"## **API Minha Visita**\n\nA **API Minha Visita** disponibiliza um conjunto de consultas GraphQL voltadas à integração e consumo de dados do sistema.\n\nEla foi projetada para fornecer informações consistentes e reutilizáveis, apoiando fluxos principais por meio de **rotas auxiliares** como usuários, equipes, atividades, status, produtos, tendências e campos customizados.\n\n---\n\n## Endpoint GraphQL\n\nTodas as requisições devem ser realizadas exclusivamente no endpoint abaixo:\n\n[https://api.minhavisita.com.br/graphql](https://api.minhavisita.com.br/graphql)\n\nAPI **não possui múltiplas rotas REST**, concentrando todo o acesso em uma única rota GraphQL.\n\n---\n\n## Autenticação\n\nPara realizar consultas na API, é **obrigatório** informar uma **integration-key** válida.\n\nA `integration-key` deve ser enviada no header da requisição e é utilizada para:\n\n- Identificar a integração\n    \n- Controlar o acesso às consultas disponíveis\n    \n- Garantir segurança e rastreabilidade das requisições\n    \n\nSem essa chave, as requisições não serão autorizadas.\n\n---\n\n## Estrutura da API\n\nA API é composta principalmente por **queries de consulta**, que permitem:\n\n- Listagem de dados com paginação\n    \n- Aplicação de filtros avançados\n    \n- Ordenação personalizada\n    \n- Relacionamentos entre entidades\n    \n\n---\n\n## Exemplos de Recursos Disponíveis\n\nEntre os principais recursos expostos pela API estão:\n\n- **Users**: usuários, permissões e relacionamentos organizacionais\n    \n- **Teams**: equipes, usuários vinculados e escopos de atuação\n    \n- **Activities**: atividades de apoio a checks e status\n    \n- **CustomerStatus**: status e estágios do cliente\n    \n- **Customers**: dados cadastrais e relacionamentos dos clientes\n    \n- **Checks**: registros de visitas, validações e execuções realizadas no sistema\n    \n- **Events**: eventos operacionais e registros de ações associadas aos fluxos\n    \n- **CustomFields**: campos personalizados e dinâmicos\n    \n- **Products**: produtos cadastrados para controle e análise\n    \n- **Trends**: tendências e registros categorizados para análises e controles\n    \n\n---\n\n## Suporte e Contato\n\nEm caso de dúvidas, problemas de integração ou necessidade de suporte técnico, entre em contato pelo e-mail:\n\n📧 [<b>integracao@minhavisita.com.br</b>](https://mailto:integracao@minhavisita.com.br)\n\nNossa equipe está disponível para auxiliar durante o processo de integração.\n\n---\n\nEsta documentação tem como objetivo facilitar o entendimento da API e garantir uma integração clara, segura e consistente com o sistema **Minha Visita**.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"42662157","team":13347516,"collectionId":"5ff9a15e-f3ed-424f-b4b8-c2f6db7196d4","publishedId":"2sBXc8pPTK","public":true,"publicUrl":"https://documenter-api.postman.tech/view/42662157/2sBXc8pPTK","privateUrl":"https://go.postman.co/documentation/42662157-5ff9a15e-f3ed-424f-b4b8-c2f6db7196d4","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0090CB"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"GraphQL API da plataforma Minha Visita para integração com sistemas externos e automações. Permite acesso a clientes, visitas, atividades, equipes, dados de campo em tempo real, agenda, etc"},{"name":"title","value":"Minha Visita API | GraphQL Integration Docs"}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":"https://content.pstmn.io/7d4ee573-82ce-48b6-a394-d57500b3b6df/bXYgYmx1ZS5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"0090CB"}},{"name":"light","logo":"https://content.pstmn.io/7d4ee573-82ce-48b6-a394-d57500b3b6df/bXYgYmx1ZS5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0090CB"}}]}},"version":"8.12.11","publishDate":"2026-02-09T19:00:26.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Minha Visita API | GraphQL Integration Docs","description":"GraphQL API da plataforma Minha Visita para integração com sistemas externos e automações. Permite acesso a clientes, visitas, atividades, equipes, dados de campo em tempo real, agenda, etc"},"logos":{"logoLight":"https://content.pstmn.io/7d4ee573-82ce-48b6-a394-d57500b3b6df/bXYgYmx1ZS5wbmc=","logoDark":"https://content.pstmn.io/7d4ee573-82ce-48b6-a394-d57500b3b6df/bXYgYmx1ZS5wbmc="}},"statusCode":200},"environments":[{"name":"API - Integração","id":"5cf92a63-d443-48c3-912e-a497ba300619","owner":"42662157","values":[{"key":"baseUrl","value":"https://api.minhavisita.com.br/graphql","enabled":true,"type":"default"},{"key":"integrationKey","value":"SUA_CHAVE_DE_INTEGRAÇÃO","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/d0686f0d9c3eb06f5c9f0dff19f57a8ee64e3e5d4c466d23f204dadcbe346c46","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"API - Integração","value":"42662157-5cf92a63-d443-48c3-912e-a497ba300619"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sBXc8pPTK"}