{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"7b139f2c-51c9-4873-8ddb-34224b617247","name":"Zomentum API Documentation","description":"The Zomentum API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON request bodies (for POST and PUT requests) and returns JSON-encoded responses, using standard HTTP response codes, authentication, and verbs.\n\n# Overview\nPlease note that these API docs are in beta. While our APIs are backward compatible, there maybe delays between a new feature releasing and it being documented in our APIs. Our engineers are happy to get on a call to help you design a solution. Please reach out to support@zomentum.com for queries or to schedule a solution call.\n# Authentication\nZomentum APIs use Bearer authentication (also called token authentication) to authenticate API requests. You can get the API token in 3 simple steps:\n1. Create an API user. \nNavigate to Settings -> Users -> Add User.  Make sure to pick the permission level to API User. You can use the default owner field to specify who should be the default owner for objects created by this API user. \n2. Once the API user has been created, please click on the generate token button.\n3. The access token and refresh token will now be generated.\n3. The access token can now be used to authenticate any of the APIs using the Bearer Authentication method.\n4. The access token can be refreshed using the Refresh Token API. This API will use the refresh token for authentication. Note that, once you generate a new access token, the old one will be invalidated.\n\n\n# Error Codes\n- HTTP 400 - For client errors i.e. bad params, invalid reference ids, misconfigured JSON bodies etc.\n- HTTP 401 - For authentication errors or when the access token has expired. You may refresh the access token programmatically using the Refresh Token API\n- HTTP 403 - If the user is not authorized to use this API resource and method\n- HTTP 404 - Resource not found\n- HTTP 500 - Server error. This should be rare. Should you see an HTTP 500, please reach out to support@zomentum.com with the stack trace as well as API details and we will help you in the debugging process\n\nError responses will have a JSON body giving more information about the error.\nEach error JSON may have the following keys:\n\n- message[String] - Top-level error message explaining the problem\n- child_exceptions [Array[Object]] - An array of objects that give details of all errors for this    request. Each child_exception is an object of the following type:\n    - description[String] - String describing details about this child error\n    - exception_type[Enumeration] - The possible values are:\n        - \"Cf Authorization Exception\"\n        - \"Invalid Merge Tag Exception\"\n        - \"Unexpected Database Exception\"\n        - \"Company Not Found Exception\"\n        - \"User Not Found Exception\"\n        - \"Pipeline Exception\"\n        - \"Bad Params Query Builder Exception\"\n        - \"Uniqueness Constraint Exception\"\n        - \"Dry Run Exception\"\n        - \"Entity Not Found Exception\"\n        - \"Validation Exception\"\n        - \"Unsafe Put Request Exception\"\n        - \"Bad Request Exception\"\n        - \"Internal Server Exception\"\n        - \"Auth Support Exception\"\n        - \"Expired Token Exception\"\n        - \"Access Exception\"\n        - \"Integration Exception\"\n\n# Filters\nMost multi-fetch APIs can be filtered via a query param 'filters'.\nThis param can be used to pass multiple filters via the same query. Filters are formatted as the following: **field1:operator1:value1;field2:operator2:value2;...**. Note that:\n-  Different filters are separate from one and another by semi-colons.\n-  Each filter itself has 3 parts, each separate by a colon. \n-  The first part represents the field name i.e. the filed you are filtering the data on. \n-  The second part is the operator i.e. the operator that should be applied on the field.\n-  The third part represents the value that should be applied in the filter. For in and nin operators, comma-separated values can be passed\n-  Operators - The valid operators are:\n   - eq - Equal\n   - gt - Greater than\n   - lt - Lesser than\n   - gte - Greater than or equal to\n   - lte - Lesser than or equal to\n   - ne - Not Equal in - list of comma separate values\n   - nin - not in list of comma separate values\n\n# Running This In Postman\nIf you are using postman, you can hit the Run In Postman button to automatically import the entire API suite into your postman account. \nPost authorization, you can store the access_token and refresh_token in the given environment variables. This should help you test out the APIs with live production data from your account.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"12960548","team":1305713,"collectionId":"7b139f2c-51c9-4873-8ddb-34224b617247","publishedId":"TVRg6oxL","public":true,"publicUrl":"https://api-docs.zomentum.com","privateUrl":"https://go.postman.co/documentation/12960548-7b139f2c-51c9-4873-8ddb-34224b617247","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2F70F3"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.11.4","publishDate":"2020-10-29T12:09:09.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Zomentum Production","id":"ba531a0e-b335-4ac5-a1e0-7940d99041ad","owner":"12960548","values":[{"key":"url","value":"https://api.zomentum.com","enabled":true},{"key":"access_token","value":null,"enabled":true},{"key":"refresh_token","value":null,"enabled":true}],"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/a45ba8a259dffe5c9fe9550d2ee7ab19867087363a71e67531a6a8f350ecf3a9","favicon":"https://res.cloudinary.com/postman/image/upload/v1603972360/team/xemdhgf6kzdksj0elp90.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"},{"label":"Zomentum Production","value":"12960548-ba531a0e-b335-4ac5-a1e0-7940d99041ad"}],"canonicalUrl":"https://api-docs.zomentum.com/view/metadata/TVRg6oxL"}