{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"478552dd-0201-43fe-8048-cd61421ab74d","name":"Enterprise Portal - Master","description":"<img src=\"https://esgglobal.com/wp-content/uploads/2020/12/ESG-Logo.svg\" alt=\"image\">\n\n## Getting Started\n\nThe Enterprise Portal API provides endpoints to manage billing and consumer information systems for comprehensive CIS, operating expenses, project management, complex price plans, management services, custom reporting, automated watch queues and workflows through a series of HTTP requests and responses. Each folder contains requests to perform a specific operations which can be accomplished after the request has been successfully authenticated.\n\n## Authentication\n\n#### Overview\n\nFor security reasons, every request must be authenticated with a token that needs to be added to the request to make sure it has proper access. In order to get the token, proper credentials for a particular client need to be provided using the **Login** request, and if it is successful, a token will be provided in the response otherwise an authorized error will be returned.\n\n#### Generate token\n\nUse the **Login** request with the following values in the header and the body to get a token.\n\n###### Header\n\n| KEY | VALUE |\n| --- | --- |\n| client-name | {{clientName}} |\n\n###### Body\n\n```\n{\n  \"password\": \"{{password}}\",\n  \"userName\": \"{{userName}}\"\n}\n\n ```\n\n#### Response\n\n###### Success\n\nIf the credentials are valid, a success response (Status 200) will be returned and the accessToken field contains the token string.\n\n```\n{\n \"responseData\": [\n        {            \n            \"token\": {\n                \"accessToken\": {{authToken}},\n                \"tokenType\": \"Bearer\"\n            },\n}\n\n ```\n\nFor any subsequent requests, include the token string right after the word **Bearer** in the request header.\n\n| KEY | VALUE |\n| --- | --- |\n| Authorization | Bearer {{authToken}} |\n\n###### Failure\n\nIf the credentials are not valid, a failure response (Status 401) will be returned with an error message.\n\n```\n   \"errorMessage\": [\n            {\n                \"key\": \"error\",\n                \"message\": \"The provided logon credentials are invalid\"\n            }\n        ],        \n\n ```\n\n#### Regenerate token\n\nThe token will expire after 10 hours of being generated for security purposes, however, use **Login With Token** request to generate a new token to run requests successfully. Add a valid token to the request header to get a new valid token.\n\n| KEY | VALUE |\n| --- | --- |\n| Authorization | Bearer {{authToken}} |\n\n## Authorization\n\nAfter the user is successfully authenticated, the **Login** response body contains a token and also a list of permissions that the user has access to. These permissions indicate which resources are available to query and the access type such read, write, update or delete operations.\n\n```\n \"permissions\": [\n                    {\n                        \"entity\": \"AccountTask\",\n                        \"name\": \"getPromotions\",\n                        \"accessType\": \"read\"\n                    },...\n\n ```\n\n## Request List Parameters\n\nTo expose large sets of data usually return lists or search requests, pagination provides a way to reduce the amount of data sent back by limiting the amount per request. Also, sorting and exporting to control the order and format of the return results. Add the following query parameters to the URL to get the desired expected result set:\n\n- **pageSize**: specify the number of records to return in one request, specified as an integer from 1 to 100. Default value is 100.\n    \n- **pageNumber**: specify the page of results to return. Default value is 1.\n    \n- **sortField**: field in the result to sort by. Choose field from Request Fields section.\n    \n- **sortOrder**: order in which to sort the sortField by, it can be ASC or DESC. Default value is DESC.\n    \n- **export**: flag to return the entire result set, it can be true or false.\n    \n\n```\n  {{baseURL}}/search/agents?pageSize=25&pageNumber=1&sortField={{sortField}}&sortOrder=DESC    \n\n ```\n\n## Additional Information\n\nIf you have questions that aren't answered here, the [support page](https://esgglobal.com/contact/) provides details on how to get help.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"10774391","collectionId":"478552dd-0201-43fe-8048-cd61421ab74d","publishedId":"Szmjyac1","public":true,"publicUrl":"https://apidocs.esgglobal.net","privateUrl":"https://go.postman.co/documentation/10774391-478552dd-0201-43fe-8048-cd61421ab74d","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.11.4","publishDate":"2025-04-07T16:04: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/4841d10add1121ba5b7e4ff673f3a781b008eebac83f9c72f70595cb3f785881","favicon":"https://esgglobal.net/favicon.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://apidocs.esgglobal.net/view/metadata/Szmjyac1"}