{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"f01d7342-0782-4693-97b5-daf674550809","name":"Kato Client API","description":"Welcome to Kato API. Here are some pre-made requests for you to explore the API using [Postman](https://getpostman.com)\n\n# API Keys\n\nYou'll need API keys to authenticate with the Kato API.  \nThese are provided to you by us, please contact [help@kato.app](https://mailto:help@kato.app) if you have lost or require new keyss.\n\nWe provide you with a specific `client id` and `client secret` for your organisation.  \nThink of these like a password:\n\n- Store it securely.\n    \n- Don't share it with anyone outside of your organisation.\n    \n- Don't put it in any code on your website or in a Url that someone could find.\n    \n\n# Authentication\n\nWe implement `OAuth 2.0` in order to provide a secure API. This means all our end points are secured and can only be accessed with calls that are authenticated with OAuth2 tokens.  \nIn order to obtain OAuth2 tokens, you must first authenticate with our authentication endpoint.\n\nThe following image shows the flow you need to implement in order to gain access to your data via the Kato API:\n\n<img src=\"https://agents-society-assets.s3.eu-west-1.amazonaws.com/oauth-flow.png\">\n\n#### 1\\. Token Request\n\nThe `/oauth/token` end point will respond with an `access_token` that can be used to access the Kato API.\n\n- The request is made `client_id` and `client_secret` in the body\n    \n- An access_token is generated and returned.\n    \n- The access_token can be used to make requests to the Kato API\n    \n\n#### 2\\. API requests\n\nOnce you have an `access_token` you can use this to make subsequent api requests.\n\n- The 'Authorization' header should be used to send the Bearer token\n    \n- An example header would like something like this: `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGci...`\n    \n- Please _DO NOT_ send through your client_secret or client_id in these requests.\n    \n\n#### 3\\. Expired access_token\n\nAccess tokens limit the risk of your `client_secret` becoming compromised.  \nHowever, if the access_tokens life span is too long it introduces risk that the access_token may be compromised.  \nAs such the access tokens expire after 14 days.\n\n- When you use a token that has expired the API will respond with a 401 unauthorised TBD...\n    \n- When an access token expires please request a new token.\n    \n\n# Environment\n\n| Environment | Client API Url | Web App Url |\n| --- | --- | --- |\n| Sandbox | [https://client-api.integrations.kato-sandbox.app](https://client-api.integrations.kato-sandbox.app) | [https://kato-sandbox.app](https://kato-sandbox.app) |\n| Production | [https://client-api.kato.app](https://client-api.kato.app) | [https://kato.app](https://kato.app) |\n\nNotes:\n\n- Your platform will have separate API keys for each environment.\n    \n- Data created or modified in each environment will not affect the other.\n    \n- Data cannot be transferred from one environment to the other.\n    \n\n# Versions\n\nIf any breaking changes are made on an endpoint, then those change will be rolled out in a new version of the API.  \nThe version of an endpoint to use must be sent by adding a prefixed path to the api:\n\n- {{base-api-url}}/v1/...\n    \n- {{base-api-url}}/v2/...\n    \n\n# Deprecation\n\nDeprecated endpoints are marked with \"- Deprecated\".  \nThe documentation for these endpoints will indicate when the endpoint was deprecated, as well as the proper alternative endpoint to use.\n\n# Rate Limiting\n\n- Requests are limited to 60 per minute.\n    \n- If you have exceeded your quota, a \"429: Too Many Requests\" response will be received.\n    \n\n# API Pricing\n\nKato offers two types of API Pricing depending on your needs:\n\n- Listing current availability (for example to be used on public facing websites).\n    \n- CRM Integration (For example when you want to control your availability from an internal system).\n    \n\nPlease contact us here to discuss your needs further at [help@kato.app](https://mailto:help@kato.app)\n\n# Pagination\n\nWhen querying a 'List' endpoint, the response will be paginated for performance.  \nIf for example there are 100,000 results, pagination allows the results to be returned a page at a time.\n\nYou can use the `limit` parameter to change how many results are returned per page.  \nThe default page size is specified varies depending on the end point requested.\n\nYou can use the `page` parameter to select which page you want to see.  \nFor example, if the limit is 50, page 1 would return results 1 to 50, page 2 would return results 51 to 52 etc.\n\nAt the bottom of each response you will see a `pagination` block providing a summary of the data you have requested. This appears as follows:\n\n- `from`: First result this page\n    \n- `to`: Last result this page\n    \n- `total`: Count of results in total\n    \n- `count`: Count of results this page\n    \n- `per_page`: Number of results per page (see `limit` param)\n    \n- `current_page`: Current page number (see `page` param)\n    \n- `total_pages`: Total number of pages\n    \n- `links`:\n    \n    - `first`: Navigate to the first page\n        \n    - `previous`: Navigate to the previous page\n        \n    - `fastback`: Navigate 10 pages back\n        \n    - `next`: Navigate to the next page\n        \n    - `fastforward`: Navigate 10 pages forward\n        \n    - `last`: Navigate to the last page\n        \n\nTake careful note of the `total_pages` count. If there are more than one, simply update the request to fetch page 2 of the results.\n\nWhen using the links provided, don't forget to append any additional search params.\n\n# Questions/Comments/Suggestions\n\nIf you have any questions or comments, please let us know at [help@kato.app](https://mailto:help@kato.app)\n\n# Changelog\n\n##### 10-JUN-2022\n\n- Changing base url to https://client-api.integrations.kato-sandbox.app\n    \n\n##### 10-JUN-2022\n\n- Added `Society Disposals - Listing` section\n    \n\n##### 08-APR-2022\n\n- Availability: Reviewed metric options\n    \n\n##### 09-JUN-2021\n\n- Availability: Added `api_controlled`\n    \n- Availability: Added `api_controlled` filter\n    \n\n##### 27-APR-2021\n\n- Availability: Added `published_to_website` and `status` filters\n    \n\n##### 22-APR-2021\n\n- Availability: Pagination limit changed to 50\n    \n- Availability: Rate limit defined as 60 requests / minute\n    \n\n##### 21-APR-2021\n\n- Availability: Added `marketing_columns` to `floor_units`\n    \n\n##### 06-APR-2021\n\n- Availability: Added `type` to `videos`\n    \n\n##### 25-MAR-2021\n\n- Availability: Added `fitted_space`\n    \n- Availability: Added `fitted_space_comment`\n    \n- Availability: Added 'particulars' to files->type options\n    \n\n##### 15-MAR-2021\n\n- Availability: Added `reference_number`\n    \n\n##### 01-FEB-2021\n\n- List Availability: Added `sort_by` param. Added `currency` throughout\n    \n- Show Availability: Added `currency` throughout","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"2269173","team":2007245,"collectionId":"f01d7342-0782-4693-97b5-daf674550809","publishedId":"TzY6BFMy","public":true,"publicUrl":"https://api-docs.kato.app","privateUrl":"https://go.postman.co/documentation/2269173-f01d7342-0782-4693-97b5-daf674550809","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.0","publishDate":"2024-02-23T09:59:43.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Sandbox","id":"f901d28c-3916-4f48-975d-8a1728a84412","owner":"2269173","values":[{"key":"base-api-url","value":"https://client-api.integrations.kato-sandbox.app","enabled":true,"type":"default"},{"key":"client_id","value":"","enabled":true,"type":"secret"},{"key":"client_secret","value":"","enabled":true,"type":"secret"},{"key":"client_access_token","value":"YOUR-ACCESS-TOKEN-HERE- (From Client Access Token request)","enabled":true,"type":"secret"}],"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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://kato.app/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"},{"label":"Sandbox","value":"2269173-f901d28c-3916-4f48-975d-8a1728a84412"}],"canonicalUrl":"https://api-docs.kato.app/view/metadata/TzY6BFMy"}