{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"1651d1ff-9b24-45af-8611-cff297997f9b","name":"API","description":"Esta API permite criar aplicações parceiras ao ecossistema Poli.\n\nNesta documentação, há exemplos de respostas e eventos da API.\n\nToda request que retorna um objeto ou uma collection, por padrão, retorna exclusivamente os dados mais básicos, caso seja necessário, a request pode solicitar demais atributos passando como parâmetro ?include=\n\nPor exemplo: /users?include=attributes,status_of_service\n\n## Host\n\nO nosso domínio base é `https://foundation-api.poli.digital/v3`\n\n## Autenticação\n\nPara ter acesso, é preciso criar um aplicativo dentro da nossa plataforma e gerar um token.\n\nExiste duas formas de criar um aplicativo: público ou privado.\n\n- Um aplicativo privado é de acesso restrito a empresa que a criou\n    \n- Um aplicativo público pode entrar em nosso marketplace de integrações, podendo assim qualquer empresa interessada ter acesso. Neste caso o aplicativo poderá excutar o webhook de todas as empresas e precisará fazer a gestão \"multi-tenancy\"\n    \n\nO token precisa ser passado no Header como Authentication do tipo Bearer\n\n- Após cadastrar um aplicativo, é preciso cadastrar um token. Caso necessário, também é possível cadastrar um webhook, informando quais eventos deseja receber.\n    \n\n## Filtro, pesquisa, ordenação e paginação\n\nAlgumas coleções permitem pesquisar, filtrar, paginar e ordenar os itens. Para tal, use na URL as palávras mágicas:\n\n- search\n    \n    - Busca textual ampla em cima dos itens pesquisáveis. Útil para buscar nomes, emails, telefones e afins.\n        \n    - /accounts/{{account_uuid}}/users?include=attributes&search=joão\n        \n- order\n    \n    - Dado algum atributo, utilize a ordenação para filtrar de forma ascendente ou descendente (acrescentando o símbolo de negativo na frente)\n        \n    - /accounts/{{account_uuid}}/users?include=attributes&order=created_at\n        \n    - /accounts/{{account_uuid}}/users?include=attributes&order=-created_at\n        \n- page\n    \n    - Para coleções com diversas páginas, utilize ?page= para escolher a página desejada. Por padrão, começamos na primeira página e podemos avançar até a última\n        \n    - /accounts/{{account_uuid}}/users?include=attributes&page=2\n        \n- per_page\n    \n    - Por padrão, a listagem exibe 15 itens por página. Este valor pode ser aumentado(até 100 itens) ou diminuído.\n        \n- include\n    \n    - Define os parâmetros que você receberá na sua request. É preciso definit item a item, como por exemplo `/users?include=status,status_of_service,email,attributes`\n        \n\n## Filtros temporais e de relacionamento\n\nA partir de buscas específicas (como por exemplo o campo \"created_at\", ou \"uuid\"), especificar parâmetros relacionais, como \"maior que\", \"menor que\" e \"entre\". Abaixo estão as opções e como utilizá-los\n\nEm buscas por data, é preciso usar sempre no formato ISO, contendo ou não horário. Por exemplo, é aceito \"2024-07-26\" e \"2024-05-26T18:42:29.000000Z\"\n\nAlém disso, **um mesmo parâmetro NÃO pode ser usado duas vezes**. Ou seja, se precisar de registros com a data de criação maior que 2024-06-01 e menor que 2024-07-01, é preciso usar **between**.\n\n- lt\n    \n    - Útil para buscas númericas e temporais, como \"retorne os registros com data **menor que** 2024-03-02\"\n        \n    - `/contacts/{{ contact_uuid }}/messages?created_at=lt(2024-07-26T18:42:29.000000Z)`\n        \n- gt\n    \n    - Útil para buscas númericas e temporais, como \"retorne os registros com data **maior que** 2024-03-02\"\n        \n    - `/contacts/{{ contact_uuid }}/messages?created_at=gt(2024-07-26T18:42:29.000000Z)`\n        \n- between\n    \n    - Útil para buscas númericas e temporais, como \"retorne os registros com data **menor que** 2024-03-01 e **maior que** 2024-04-01\"\n        \n    - `/contacts/{{ contact_uuid }}/messages?created_at=between(2024-03-01,2024-04-01)`\n        \n- in\n    \n    - Útil para buscas com mais de um registro, e com assertividade **exata**. Por exemplo, \"mensagens com uuid dentro da lista \\[\"9a7e6be5-299b-4519-bc75-6276e7872306\", \"75dca1c2-0f76-49b4-a3a6-dad879a42c08\", \"75dca1c2-0f76-49b4-a3a6-dad879a42c08\"\\]\n        \n\n## Rate Limit\n\n- Toda a aplicação utiliza um mesmo rate limit de 60 requests por minutos. Otimize suas requests e crie fila na sua aplicação para não exceder este valor.\n    \n\n## Webhooks\n\n- Prefira usar um serviço de filas em sua aplicação caso vá escutar eventos via webhook. Por mais que possuímos retries, a aplicação descartará eventos que não receberam sucesso do lado do cliente após algumas tentativas. A recomendação é tratar o evento de forma assíncrona.\n    \n- Registre em seu webhook apenas eventos que você precisará escutar. O cadastro de mais itens pode sobrecarregar seu sistema e deixar a aplicação mais lenta.\n    \n- Veja os [Eventos produzidos pelo ecossistema](https://developers.poli.digital/#67148bff-6d94-4ab9-9077-b8553efb30a2) na seção \"Webhook Events\"\n    \n\n## Demais recomendações\n\n- Evite requests que trazem mais informações do que o necessário. Escolha o que precisa usando o ?include. Isso otimiza suas consultas trazendo resultados de forma mais rápidas","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"24009576","collectionId":"1651d1ff-9b24-45af-8611-cff297997f9b","publishedId":"2s9YsDiuHY","public":true,"publicUrl":"https://developers.poli.digital","privateUrl":"https://go.postman.co/documentation/24009576-1651d1ff-9b24-45af-8611-cff297997f9b","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2025-08-28T19:30:37.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"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/8492e95fca07933ae07e97ebb662043a4aa8d6a9a1295307d485ef4c6e57ba86","favicon":"https://res.cloudinary.com/postman/image/upload/v1703858304/team/s9v0vho7y4lxq51hitq0.ico"},"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"}],"canonicalUrl":"https://developers.poli.digital/view/metadata/2s9YsDiuHY"}