{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"caa40767-99e3-421a-9cff-873fbd39dc47","name":"Ekmob API","description":"# Welcome to Ekmob.Api\n\nUsing this api, you can accomplish 3rd party integrations and sync your data to your other business software. Please contact Ekmob on how to obtain access.\n\n# Important notes\n\nPlease read the following notes carefully before start using the api. These notes include basic and general information about how to use the end-points and best practices.\n\n## Accessing the API\n\nEkmob.Api requires a `client-id` and a `client_secret` for authorization. These values are provided by Ekmob and are not available with online sign-up (currently). Also, every request has a required `scope`.  \nThe `client` and `scope` matching is handled by Ekmob and provided to you on the terms of your api usage. When you try to access an end-point which requires an access that your access token did not include, you will simply receive a `403-Forbidden` error.\n\n# API Errors\n\nReturns when all sent requests fail **HTTP Status Code** : 400 Bad Request\n\nReturns if all requests sent are successful **HTTP Status Code** : 200 OK\n\nIf the response returned from the request is HTTP Status Code 400 Bad Request, the response header should be checked. In the response header\n\nERRORCODE \"error code\"  \nERRORMESSAGE: \"error description\"\n\nvalues are available.\n\n## Compression\n\nEkmob.Api responses support **Brotli** compression. Please make sure that your requests include the item in the header:\n\n`Accept-Encoding: br`\n\n## Routes\n\nYou can use the following routes for accessing the APIs:\n\n| Api | Explanation | Url |\n| --- | --- | --- |\n| Ekmob.Idm | Authorization and refresh tokens | [http://localhost:8011](http://localhost:8011) |\n| Ekmob.Core | Basic GetList and CRUD operations on Ekmob Entities | [http://localhost:8012](http://localhost:8012) |\n\n## GetList methods\n\nEvery **GetList** end-point have (there may be exceptions) common query parameters. You can find the explanations and best practices below:\n\n| Parameter | Explanation |\n| --- | --- |\n| index | Ekmob.Api works with paging so you can adjust your result set size and servers stays optimized. This parameter is used to state the starting page number. Paging starts at 0 and this value is used if this parameter is omitted. |\n| size | Number of records desired to be in a page. Maximum number can be used is 100. Sending a larger number than 100 will NOT result in error. Only 100 records will be returned. If omitted, default value 20 is used. |\n| orderBy | Comma separated values of fields to be used in sorting. For sorting in a descending manner use \":D\" after the property name. Ex: `Code:D` |\n| include | Comma separated property names to be included in the result list. Most of the times you will not need the full result so it is efficient to use this parameter. Ex: `Code,Description`  <br>Also, navigation properties are supported. For example, If your result set `Customer` has an object in the result set, `City`, you can include its partial properties. Ex: `Code,City,City.Code`  <br>In such cases, please note that `City` should be included for `City.Code` to be included |\n| exclude | Comma separated property names to be excluded form the result list. Used with the same logic explained in include, only the stated properties are excluded from the result set. |\n| queryString | To limit the result set, you can use Linq based expressions. Only some basic operands and unary are supported. Please see the next section for detailed explanation. |\n| searchText | Pattern to be searched in `string` type properties. Search is performed using the `Contains` logic. |\n| searchIn | Comma separated property names to search the `searchText` in. If omitted, search is performed in all properties that are marked as `IsSearchable`. |\n| includeDeleted | In some entities deleted records are not physically removed from the database for client syncing purposes. They are periodically processed and garbage-collected in a timely manner. If you wish to include the deleted records in your result set, send this paramneter as `true`. It is `false` by default when omitted. |\n| includeCount | If sent `true`, the result set will have `Count` property with the number of records without paging. Please beware that this option highly affects performance . It is `false` by default when omitted. |\n| customFieldReturnType | Some entities have custom field defined within their account. In such cases, `GetList` type end-points have this parameter. Each custom field has a unique id with `GUID` type. Valid inputs are:  <br>0 - Do not include any custom fields.  <br>1 - Include all custom fields.  <br>2 - Include all custom fields and use IDs as their property names.  <br>  <br>You can include/exclude custom fields from your result set like any other field. |\n\n## queryString Parameter\n\nWhen you wish to limit the result set you can use the **queryString** parameter. You can use nested statements with supported binary operators along with navigation properties. Here are some examples:\n\n`Address.Contains(\"Istanbul\")`\n\n`Address.StartsWith(\"H\")`\n\n`Address.EndsWith(\"A\")`\n\n`Code.StartsWith(\"Top\") AND (City.Code == \"01\" OR (City.Code == \"02\")`\n\n`Amount > 1000 AND Total < 20000`\n\nSupported keywords, methods and operators are:  \n`Contains` , `StartsWith` and `EndsWith` for string typed properties\n\n`AND` , `OR` , `>` , `>=` , `<` , `<=` are the binary operators.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"9210790","team":549135,"collectionId":"caa40767-99e3-421a-9cff-873fbd39dc47","publishedId":"2s9YeN1oaF","public":true,"publicUrl":"https://developer.ekmob.com","privateUrl":"https://go.postman.co/documentation/9210790-caa40767-99e3-421a-9cff-873fbd39dc47","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.2","publishDate":"2025-07-08T12:15:45.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/9454bea7fdb598fd4046d79f84cbac20fc372139df86b5b1ce5ff6b45c015eb2","favicon":"https://res.cloudinary.com/postman/image/upload/v1607345553/team/inol3kzs4gmny1w2etx9.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://developer.ekmob.com/view/metadata/2s9YeN1oaF"}