Welcome to Kato API. Here are some pre-made requests for you to explore the API using Postman
\nYou'll need API keys to authenticate with the Kato API.
These are provided to you by us, please contact help@kato.app if you have lost or require new keys.
We provide you with a specific client id and client secret for your organisation.
Think of these like a password:
Store it securely.
\nDon't share it with anyone outside of your organisation.
\nDon't put it in any code on your website or in a URL that someone could find.
\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.
In order to obtain OAuth2 tokens, you must first authenticate with our authentication endpoint.
The following image shows the flow you need to implement in order to gain access to your data via the Kato API:
\n![](\"https://agents-society-assets.s3.eu-west-1.amazonaws.com/oauth-flow.png\")
\n\nThe /oauth/token end point will respond with an access_token that can be used to access the Kato API.
The request is made client_id and client_secret in the body
An access_token is generated and returned.
\nThe access_token can be used to make requests to the Kato API
\nOnce you have an access_token you can use this to make subsequent api requests.
The 'Authorization' header should be used to send the Bearer token
\nAn example header would like something like this: Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGci...
Please DO NOT send through your client_secret or client_id in these requests.
\nAccess tokens limit the risk of your client_secret becoming compromised.
However, if the access_tokens life span is too long it introduces risk that the access_token may be compromised.
As such the access tokens expire after 14 days.
When you use a token that has expired the API will respond with a 401 unauthorised TBD...
\nWhen an access token expires please request a new token.
\nNotes:
\nYour platform will have separate API keys for each environment.
\nData created or modified in each environment will not affect the other.
\nData cannot be transferred from one environment to the other.
\nIf any breaking changes are made on an endpoint, then those change will be rolled out in a new version of the API.
The version of an endpoint to use must be sent by adding a prefixed path to the api:
{{base-api-url}}/v1/...
\n{{base-api-url}}/v2/...
\nDeprecated endpoints are marked with \"- Deprecated\".
The documentation for these endpoints will indicate when the endpoint was deprecated, as well as the proper alternative endpoint to use.
Packages begin at 60 requests per minute. Please discuss this with your account manager if you need more.
\nIf you have exceeded your quota, a \"429: Too Many Requests\" response will be received.
\nPlease contact us here to discuss your needs further at help@kato.app
\nWhen querying a 'List' endpoint, the response will be paginated for performance.
If for example there are 20,000 results, pagination allows the results to be returned a page at a time.
You can use the limit parameter to change how many results are returned per page.
The default page size is specified varies depending on the end point requested.
You can use the page parameter to select which page you want to see.
For example, if the limit is 50, page 1 would return results 1 to 50, page 2 would return results 51 to 52 etc.
At the bottom of each response you will see a pagination block providing a summary of the data you have requested. This appears as follows:
from: First result this page
to: Last result this page
total: Count of results in total
count: Count of results this page
per_page: Number of results per page (see limit param)
current_page: Current page number (see page param)
total_pages: Total number of pages
links:
first: Navigate to the first page
previous: Navigate to the previous page
fastback: Navigate 10 pages back
next: Navigate to the next page
fastforward: Navigate 10 pages forward
last: Navigate to the last page
Take careful note of the total_pages count. If there are more than one, simply update the request to fetch page 2 of the results.
When using the links provided, don't forget to append any additional search params.
\nIf you have any questions or comments, please let us know at help@kato.app
\n22-June-2026
\nActivity: renamed causer_id to user_id and added user_name .
Disposals: added agencies (deduplicated list of agent companies).
record_owner / assignee / matched_by now populate for agents outside your organisation.
\nThis should always be client_credentials (other options are not available on the client api)
\n"},{"key":"client_id","value":"{{client_id}}","type":"text","description":"Client ID - Provided by AgentsInsight
\n"},{"key":"client_secret","value":"{{client_secret}}","type":"text","description":"Client Secret - Provided by AgentsInsight
\n"},{"key":"scope","value":"*","type":"text","description":"This should always be set to *
\n"}]},"url":"{{landlord_base_url}}/oauth/token","urlObject":{"path":["oauth","token"],"host":["{{landlord_base_url}}"],"query":[],"variable":[]}},"response":[{"id":"5b636152-5659-49c4-aa29-254bb48f0c50","name":"Client Access Token Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","type":"text"},{"key":"client_id","value":"your-client-id-here","type":"text"},{"key":"client_secret","value":"your-client-secret-here","type":"text"},{"key":"scope","value":"*","type":"text"}]},"url":"{{landlord_base_url}}/oauth/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.15.8"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"pragma","value":"no-cache"},{"key":"Cache-Control","value":"no-store, private"},{"key":"Date","value":"Tue, 08 Jun 2021 06:22:38 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"token_type\": \"Bearer\",\n \"expires_in\": 1296000,\n \"access_token\": \"xxxx\"\n}"}],"_postman_id":"30420f42-3058-4b34-b645-4f4a39162dbb"}],"id":"b7dd8180-0140-428a-a25d-f083be7cd9f2","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"4793e3b2-8106-4456-a06a-924be65b42a0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"95f0765f-bbde-492a-932e-45e926592b54","type":"text/javascript","exec":[""]}}],"_postman_id":"b7dd8180-0140-428a-a25d-f083be7cd9f2","description":""},{"name":"V1","item":[{"name":"Disposals","item":[{"name":"List Disposals","id":"4887f491-7592-4e23-bc70-f1e55bed0c19","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{landlord_base_url}}/v1/disposals?page=1&per_page=25&status=2&sort=updated_at&order=desc","description":"Retrieve a paginated list of disposals for the authenticated landlord organisation
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{client_access_token}}"}]},"isInherited":true,"source":{"_postman_id":"3bec4886-730d-4866-88fc-3990852a41ba","id":"3bec4886-730d-4866-88fc-3990852a41ba","name":"V1","type":"folder"}},"urlObject":{"path":["v1","disposals"],"host":["{{landlord_base_url}}"],"query":[{"description":{"content":"Page number
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Items per page (max 100)
\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"Search term for disposal details
\n","type":"text/plain"},"key":"search","value":""},{"description":{"content":"Filter by disposal status
\n","type":"text/plain"},"key":"status","value":"2"},{"description":{"content":"Sort field
\n","type":"text/plain"},"key":"sort","value":"updated_at"},{"description":{"content":"Sort order
\n","type":"text/plain"},"key":"order","value":"desc"}],"variable":[]}},"response":[{"id":"281877c6-7eeb-43b7-b1b0-163067da017a","name":"List Disposals - Example Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/disposals?page=1&per_page=25","path":["disposals"],"query":[{"key":"page","value":"1"},{"key":"per_page","value":"25"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 12345,\n \"address\": {\n \"line_1\": \"123 Commercial Street\",\n \"line_2\": \"Suite 4B\",\n \"town\": \"London\",\n \"county\": \"Greater London\",\n \"postcode\": \"EC1A 1AA\",\n \"country\": \"United Kingdom\"\n },\n \"agents\": [\n {\n \"name\": \"John Smith (Company name)\",\n }\n ],\n \"assigned_users\": [\n {\n \"name\": \"John Smith\",\n \"email\": \"john.smith@example.com\",\n \"phone\": \"+44 20 7123 4567\"\n },\n {\n \"name\": \"John Doe\",\n \"email\": \"doe.john@example.com\",\n \"phone\": \"+44 20 7123 4567\"\n }\n ],\n \"api_locked\": false,\n \"building_types\": [\"office\"],\n \"for_sale\": false,\n \"image\": \"https://cdn.example.com/property-image.jpg\",\n \"is_investment_sale\": false,\n \"is_portfolio\": false,\n \"lat\": 51.5074,\n \"lng\": -0.1278,\n \"lot_size\": \"£200 per sq ft\",\n \"price_fields\": {\n \"qualifier\": 4,\n \"value\": 1200,\n \"suffix\": \"\",\n \"poa\": false,\n \"currency\": \"gbp\"\n },\n \"price\": \"£500,000\",\n \"rent_fields\": {\n \"prefix\": \"\",\n \"from\": null,\n \"to\": null,\n \"metric\": \"sqft\",\n \"frequency\": \"per_annum\",\n \"suffix\": \"\",\n \"from_sqft\": null,\n \"to_sqft\": null,\n \"rates\": \"na\",\n \"currency\": \"gbp\"\n },\n \"rent\": \"£25,000 per annum\",\n \"size_fields\": {\n \"from\": null,\n \"to\": null,\n \"value\": null,\n \"metric\": \"sqft\",\n \"measure\": \"\",\n \"from_sqft\": null,\n \"to_sqft\": null\n },\n \"size\": \"2,500 sq ft\",\n \"status\": 2,\n \"status_string\": \"Available\",\n \"to_let\": true,\n \"created_at\": \"2024-01-15 10:30:00\",\n \"updated_at\": \"2024-01-20 14:45:00\"\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total\": 150,\n \"last_page\": 6\n },\n \"links\": {\n \"first\": \"{{landlord_base_url}}/disposals?page=1\",\n \"last\": \"{{landlord_base_url}}/disposals?page=6\",\n \"prev\": null,\n \"next\": \"{{landlord_base_url}}/disposals?page=2\"\n }\n}"}],"_postman_id":"4887f491-7592-4e23-bc70-f1e55bed0c19"},{"name":"Show Disposal","id":"68e49019-1e46-4698-8a37-1ceb357fe958","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{landlord_base_url}}/v1/disposals/:id","description":"Retrieve detailed information for a specific disposal
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{client_access_token}}"}]},"isInherited":true,"source":{"_postman_id":"3bec4886-730d-4866-88fc-3990852a41ba","id":"3bec4886-730d-4866-88fc-3990852a41ba","name":"V1","type":"folder"}},"urlObject":{"path":["v1","disposals",":id"],"host":["{{landlord_base_url}}"],"query":[],"variable":[{"description":{"content":"Disposal ID
\n","type":"text/plain"},"type":"any","value":"308254","key":"id"}]}},"response":[{"id":"72809280-b53d-4f3a-b423-764239514068","name":"Show Disposal - Example Response","originalRequest":{"method":"GET","header":[],"url":"/disposals/12345"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 12345,\n \"address\": {\n \"line_1\": \"123 Commercial Street\",\n \"line_2\": \"Suite 4B\",\n \"town\": \"London\",\n \"county\": \"Greater London\",\n \"postcode\": \"EC1A 1AA\",\n \"country\": \"United Kingdom\"\n },\n \"agents\": [\n {\n \"name\": \"John Smith (Company name)\",\n }\n ],\n \"assigned_users\": [\n {\n \"name\": \"John Smith\",\n \"email\": \"john.smith@example.com\",\n \"phone\": \"+44 20 7123 4567\"\n },\n {\n \"name\": \"John Doe\",\n \"email\": \"doe.john@example.com\",\n \"phone\": \"+44 20 7123 4567\"\n }\n ],\n \"api_locked\": false,\n \"building_types\": [\"office\"],\n \"for_sale\": false,\n \"image\": \"https://cdn.example.com/property-image.jpg\",\n \"is_investment_sale\": false,\n \"is_portfolio\": false,\n \"lat\": 51.5074,\n \"lng\": -0.1278,\n \"lot_size\": \"£200 per sq ft\",\n \"price_fields\": {\n \"qualifier\": 4,\n \"value\": 1200,\n \"suffix\": \"\",\n \"poa\": false,\n \"currency\": \"gbp\"\n },\n \"price\": \"£500,000\",\n \"rent_fields\": {\n \"prefix\": \"\",\n \"from\": null,\n \"to\": null,\n \"metric\": \"sqft\",\n \"frequency\": \"per_annum\",\n \"suffix\": \"\",\n \"from_sqft\": null,\n \"to_sqft\": null,\n \"rates\": \"na\",\n \"currency\": \"gbp\"\n },\n \"rent\": \"£25,000 per annum\",\n \"size_fields\": {\n \"from\": null,\n \"to\": null,\n \"value\": null,\n \"metric\": \"sqft\",\n \"measure\": \"\",\n \"from_sqft\": null,\n \"to_sqft\": null\n },\n \"size\": \"2,500 sq ft\",\n \"status\": 2,\n \"status_string\": \"Available\",\n \"to_let\": true,\n \"created_at\": \"2024-01-15 10:30:00\",\n \"updated_at\": \"2024-01-20 14:45:00\"\n}"}],"_postman_id":"68e49019-1e46-4698-8a37-1ceb357fe958"},{"name":"Disposal - Interest Schedule","id":"f2379ed9-2df1-47e4-b47b-d3b55f5c0b16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{landlord_base_url}}/v1/disposals/:id/interest?page=1&per_page=10&include_hidden=false&include_discounted=true&sort=updated_at","description":"Retrieve the interest schedule (interested parties) for a specific disposal
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{client_access_token}}"}]},"isInherited":true,"source":{"_postman_id":"3bec4886-730d-4866-88fc-3990852a41ba","id":"3bec4886-730d-4866-88fc-3990852a41ba","name":"V1","type":"folder"}},"urlObject":{"path":["v1","disposals",":id","interest"],"host":["{{landlord_base_url}}"],"query":[{"description":{"content":"Page number
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Items per page
\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"Comma-separated list of specific interest IDs
\n","type":"text/plain"},"key":"ids","value":"5121296"},{"description":{"content":"Include interests marked as hidden
\n","type":"text/plain"},"key":"include_hidden","value":"false"},{"description":{"content":"Include interests marked as discounted
\n","type":"text/plain"},"key":"include_discounted","value":"true"},{"disabled":true,"description":{"content":"Filter by interest status
\n","type":"text/plain"},"key":"status","value":"6"},{"description":{"content":"Sort field
\n","type":"text/plain"},"key":"sort","value":"updated_at"}],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[{"id":"31d366f3-62e5-4975-8a00-de62ac048dcb","name":"Disposal - Interest Schedule","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{landlord_base_url}}/v1/disposals/:id/interest?page=1&per_page=10&include_hidden=false&include_discounted=true&sort=updated_at","host":["{{landlord_base_url}}"],"path":["v1","disposals",":id","interest"],"query":[{"key":"page","value":"1","description":"Page number"},{"key":"per_page","value":"10","description":"Items per page"},{"key":"ids","value":"5121296","description":"Comma-separated list of specific interest IDs","disabled":true},{"key":"include_hidden","value":"false","description":"Include interests marked as hidden"},{"key":"include_discounted","value":"true","description":"Include interests marked as discounted"},{"key":"status","value":"6","description":"Filter by interest status","disabled":true},{"key":"sort","value":"updated_at","description":"Sort field"}],"variable":[{"key":"id","value":"","description":"Disposal ID"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"f2379ed9-2df1-47e4-b47b-d3b55f5c0b16"},{"name":"Disposal - Activity Log","id":"ac18da2c-c16c-4ecc-848f-cffa8c1dd2d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{landlord_base_url}}/v1/disposals/:id/activity?page=1&per_page=6&type=comment&sort=desc","description":"Retrieve activity log entries for a specific disposal with pagination
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{client_access_token}}"}]},"isInherited":true,"source":{"_postman_id":"3bec4886-730d-4866-88fc-3990852a41ba","id":"3bec4886-730d-4866-88fc-3990852a41ba","name":"V1","type":"folder"}},"urlObject":{"path":["v1","disposals",":id","activity"],"host":["{{landlord_base_url}}"],"query":[{"description":{"content":"Page number
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Items per page
\n","type":"text/plain"},"key":"per_page","value":"6"},{"description":{"content":"Filter by activity type
\n","type":"text/plain"},"key":"type","value":"comment"},{"description":{"content":"Sort order
\n","type":"text/plain"},"key":"sort","value":"desc"}],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[{"id":"b72bc0ea-c711-4fa4-b651-d3fc1ba89dcc","name":"Disposal - Activity Log - Example Response","originalRequest":{"method":"GET","header":[],"url":"/disposals/12345/activity"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 98765,\n \"organisation_id\": 789,\n \"disposal_id\": 12345,\n \"interest_id\": 67890,\n \"user_id\": 456,\n \"user_name\": \"John Doe\",\n \"activity_type\": \"comment\",\n \"description\": \"Added comment to interest record\",\n \"created_at\": \"2024-01-20T14:45:00Z\"\n },\n {\n \"id\": 98766,\n \"organisation_id\": 789,\n \"disposal_id\": 12345,\n \"interest_id\": 67890,\n \"user_id\": 456,\n \"user_name\": \"John Doe\",\n \"activity_type\": \"viewing\",\n \"description\": \"Viewing scheduled\",\n \"created_at\": \"2024-01-22T09:15:00Z\"\n },\n {\n \"id\": 98767,\n \"organisation_id\": 789,\n \"disposal_id\": 12345,\n \"interest_id\": 67890,\n \"user_id\": 456,\n \"user_name\": \"John Doe\",\n \"activity_type\": \"status_update\",\n \"description\": \"Interest status updated\",\n \"created_at\": \"2024-01-23T11:30:00Z\"\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total\": 45,\n \"last_page\": 2\n },\n \"links\": {\n \"first\": \"{{landlord_base_url}}/disposals/12345/activity?page=1\",\n \"last\": \"{{landlord_base_url}}/disposals/12345/activity?page=2\",\n \"prev\": null,\n \"next\": \"{{landlord_base_url}}/disposals/12345/activity?page=2\"\n }\n}"}],"_postman_id":"ac18da2c-c16c-4ecc-848f-cffa8c1dd2d2"}],"id":"7c461d58-6c8c-4ebf-8422-7e489ed7191e","description":"Operations related to property disposals
\nUse these endpoints to list your disposals (with filtering, sorting, and pagination; deleted disposals are excluded) and to retrieve a single disposal in full. A disposal includes its address, pricing (price, rent, and size with their structured field breakdowns), status, building types, tenure flags (for_sale, to_let, is_investment_sale, is_portfolio), location, primary image, and the assigned agents together with the deduplicated agencies representing them. From a disposal you can also drill into the tenant interest registered against it and its activity history.
\n","_postman_id":"7c461d58-6c8c-4ebf-8422-7e489ed7191e","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{client_access_token}}"}]},"isInherited":true,"source":{"_postman_id":"3bec4886-730d-4866-88fc-3990852a41ba","id":"3bec4886-730d-4866-88fc-3990852a41ba","name":"V1","type":"folder"}}},{"name":"Interest","item":[{"name":"List Interest","id":"5b59437d-bf21-482d-bac8-21870abc1ffe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{landlord_base_url}}/v1/interest?page=1&per_page=10&disposal_id=308465&sort=updated_at&order=desc&ids=5121296","description":"Retrieve a paginated list of interest records (schedule matches)
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{client_access_token}}"}]},"isInherited":true,"source":{"_postman_id":"3bec4886-730d-4866-88fc-3990852a41ba","id":"3bec4886-730d-4866-88fc-3990852a41ba","name":"V1","type":"folder"}},"urlObject":{"path":["v1","interest"],"host":["{{landlord_base_url}}"],"query":[{"description":{"content":"Page number
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Items per page
\n","type":"text/plain"},"key":"per_page","value":"10"},{"description":{"content":"Filter by disposal ID
\n","type":"text/plain"},"key":"disposal_id","value":"308465"},{"disabled":true,"description":{"content":"Filter by interest status
\n","type":"text/plain"},"key":"status","value":"6"},{"description":{"content":"Sort field
\n","type":"text/plain"},"key":"sort","value":"updated_at"},{"description":{"content":"Sort order
\n","type":"text/plain"},"key":"order","value":"desc"},{"key":"ids","value":"5121296"}],"variable":[]}},"response":[{"id":"e827e1a4-d1b5-4a74-ad9b-055fb859934e","name":"List Interest - Example Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{landlord_base_url}}/interest?disposal_id=12345","host":["{{landlord_base_url}}"],"path":["interest"],"query":[{"key":"disposal_id","value":"12345"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 67890,\n \"disposal_id\": 12345,\n \"organisation_id\": 789,\n \"status\": 3,\n \"status_string\": \"Viewing Booked\",\n \"fav\": false,\n \"interest_owner_organisation_id\": 789,\n \"interest_owner_user_id\": 456,\n \"discounted_reason\": null,\n \"discounted_reason_string\": null,\n \"record_owner\": \"Jane Doe\",\n \"hidden\": false,\n \"sort_order\": 1,\n \"interest_values\": {\n \"agent_company\": \"Knight Frank\",\n \"agent_contact\": \"Sarah Johnson\",\n \"agent_contact_email\": \"sarah.johnson@knightfrank.com\",\n \"agent_contact_mobile\": \"+44 7700 123456\",\n \"agent_contact_telephone\": \"+44 20 7629 8171\",\n \"assignee\": \"Jane Doe\",\n \"comments\": [\n {\n \"id\": 1001,\n \"text\": \"15 Jan - Client very interested, booking viewing for next week\",\n \"user_id\": 456,\n \"user_name\": \"Jane Doe\",\n \"created_at\": \"2024-01-15T14:30:00Z\"\n }\n ],\n \"completed_date\": null,\n \"current_tenancy\": \"Available immediately\",\n \"date_of_requirement\": \"10 Jan\",\n \"investment_lot_size\": null,\n \"investment_lot_size_from\": null,\n \"investment_lot_size_to\": null,\n \"investment_minimum_net_yield\": null,\n \"investment_profile\": null,\n \"investor\": \"Acme Corporation Ltd\",\n \"lease_expiry\": null,\n \"match_created\": \"15 Jan\",\n \"match_demise\": \"All Availability\",\n \"matched_by\": \"Jane Doe\",\n \"next_lease_break\": null,\n \"price_from\": null,\n \"price_to\": null,\n \"property_type\": \"Office\",\n \"rent_from\": \"£25.00 psf\",\n \"rent_metric\": \"per sq ft per annum\",\n \"rent_to\": \"£35.00 psf\",\n \"requirement_created\": \"10 Jan\",\n \"requirement_status\": \"Active\",\n \"requirement_title\": \"Central London Office Space Requirement\",\n \"requirement_updated\": \"15 Jan\",\n \"sectors\": \"Professional Services, Technology\",\n \"size_from_sqft\": \"2,000 sq ft\",\n \"size_to_sqft\": \"3,000 sq ft\",\n \"size\": \"2,000 - 3,000 sq ft\",\n \"source\": \"Website Enquiry\",\n \"submarkets\": \"City of London, Canary Wharf\",\n \"target_occupancy\": \"Q2 2024\",\n \"tenant_company\": \"Acme Corporation Ltd\",\n \"tenant_contact\": \"John Smith\",\n \"tenant_contact_email\": \"john.smith@acme.com\",\n \"tenant_contact_mobile\": \"+44 7700 987654\",\n \"tenant_contact_telephone\": \"+44 20 1234 5678\",\n \"tenant_name\": \"Acme Corporation Ltd\",\n \"tenure\": [\"Freehold\", \"Leasehold\"],\n \"tenure_string\": \"Freehold, Leasehold\",\n \"viewing_date\": \"18 Jan\",\n \"viewings_completed\": 1\n },\n \"created_at\": \"2024-01-15T10:30:00Z\",\n \"updated_at\": \"2024-01-20T14:45:00Z\",\n \"interest_schedule_updated_at\": \"20 Jan\",\n \"interest_schedule_updated_by\": \"Jane Doe\"\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total\": 8,\n \"last_page\": 1\n },\n \"links\": {\n \"first\": \"{{landlord_base_url}}/interest?page=1\",\n \"last\": \"{{landlord_base_url}}/interest?page=1\",\n \"prev\": null,\n \"next\": null\n }\n}"}],"_postman_id":"5b59437d-bf21-482d-bac8-21870abc1ffe"},{"name":"Show Interest","id":"943f8e42-d1af-47cf-bc84-370084cd8ab9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{landlord_base_url}}/v1/interest/:id","description":"Retrieve detailed information for a specific interest record
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{client_access_token}}"}]},"isInherited":true,"source":{"_postman_id":"3bec4886-730d-4866-88fc-3990852a41ba","id":"3bec4886-730d-4866-88fc-3990852a41ba","name":"V1","type":"folder"}},"urlObject":{"path":["v1","interest",":id"],"host":["{{landlord_base_url}}"],"query":[],"variable":[{"description":{"content":"Interest Record ID (Schedule Match ID)
\n","type":"text/plain"},"type":"any","value":"5047772","key":"id"}]}},"response":[{"id":"18bdab36-f4e7-4f6b-b5ad-1429310779f3","name":"Show Interest - Example Response","originalRequest":{"method":"GET","header":[],"url":"{{landlord_base_url}}/interest/67890"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 67890,\n \"disposal_id\": 12345,\n \"organisation_id\": 789,\n \"status\": 3,\n \"status_string\": \"Viewing Booked\",\n \"fav\": false,\n \"interest_owner_organisation_id\": 789,\n \"interest_owner_user_id\": 456,\n \"discounted_reason\": null,\n \"discounted_reason_string\": null,\n \"record_owner\": \"Jane Doe\",\n \"hidden\": false,\n \"sort_order\": 1,\n \"interest_values\": {\n \"agent_company\": \"Knight Frank\",\n \"agent_contact\": \"Sarah Johnson\",\n \"agent_contact_email\": \"sarah.johnson@knightfrank.com\",\n \"agent_contact_mobile\": \"+44 7700 123456\",\n \"agent_contact_telephone\": \"+44 20 7629 8171\",\n \"assignee\": \"Jane Doe\",\n \"comments\": [\n {\n \"id\": 1001,\n \"text\": \"15 Jan - Client very interested, booking viewing for next week\",\n \"user_id\": 456,\n \"user_name\": \"Jane Doe\",\n \"created_at\": \"2024-01-15T14:30:00Z\"\n },\n {\n \"id\": 1002,\n \"text\": \"18 Jan - Viewing completed, positive feedback received\",\n \"user_id\": 456,\n \"user_name\": \"Jane Doe\",\n \"created_at\": \"2024-01-18T16:45:00Z\"\n }\n ],\n \"completed_date\": null,\n \"current_tenancy\": \"Available immediately\",\n \"date_of_requirement\": \"10 Jan\",\n \"investment_lot_size\": null,\n \"investment_lot_size_from\": null,\n \"investment_lot_size_to\": null,\n \"investment_minimum_net_yield\": null,\n \"investment_profile\": null,\n \"investor\": \"Acme Corporation Ltd\",\n \"lease_expiry\": null,\n \"match_created\": \"15 Jan\",\n \"match_demise\": \"All Availability\",\n \"matched_by\": \"Jane Doe\",\n \"next_lease_break\": null,\n \"price_from\": null,\n \"price_to\": null,\n \"property_type\": \"Office\",\n \"rent_from\": \"£25.00 psf\",\n \"rent_metric\": \"per sq ft per annum\",\n \"rent_to\": \"£35.00 psf\",\n \"requirement_created\": \"10 Jan\",\n \"requirement_status\": \"Active\",\n \"requirement_title\": \"Central London Office Space Requirement\",\n \"requirement_updated\": \"15 Jan\",\n \"sectors\": \"Professional Services, Technology\",\n \"size_from_sqft\": \"2,000 sq ft\",\n \"size_to_sqft\": \"3,000 sq ft\",\n \"size\": \"2,000 - 3,000 sq ft\",\n \"source\": \"Website Enquiry\",\n \"submarkets\": \"City of London, Canary Wharf\",\n \"target_occupancy\": \"Q2 2024\",\n \"tenant_company\": \"Acme Corporation Ltd\",\n \"tenant_contact\": \"John Smith\",\n \"tenant_contact_email\": \"john.smith@acme.com\",\n \"tenant_contact_mobile\": \"+44 7700 987654\",\n \"tenant_contact_telephone\": \"+44 20 1234 5678\",\n \"tenant_name\": \"Acme Corporation Ltd\",\n \"tenure\": [\"Freehold\", \"Leasehold\"],\n \"tenure_string\": \"Freehold, Leasehold\",\n \"viewing_date\": \"18 Jan\",\n \"viewings_completed\": 1\n },\n \"created_at\": \"2024-01-15T10:30:00Z\",\n \"updated_at\": \"2024-01-20T14:45:00Z\",\n \"interest_schedule_updated_at\": \"20 Jan\",\n \"interest_schedule_updated_by\": \"Jane Doe\"\n}"}],"_postman_id":"943f8e42-d1af-47cf-bc84-370084cd8ab9"},{"name":"Activity Log","id":"4270750f-7a3a-461b-90c1-d8c61ae04b32","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{landlord_base_url}}/v1/interest/:id/activity?page=1&per_page=10&type=comment&sort=desc","description":"Retrieve activity log entries for a specific interest record with pagination
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{client_access_token}}"}]},"isInherited":true,"source":{"_postman_id":"3bec4886-730d-4866-88fc-3990852a41ba","id":"3bec4886-730d-4866-88fc-3990852a41ba","name":"V1","type":"folder"}},"urlObject":{"path":["v1","interest",":id","activity"],"host":["{{landlord_base_url}}"],"query":[{"description":{"content":"Page number
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Items per page
\n","type":"text/plain"},"key":"per_page","value":"10"},{"description":{"content":"Filter by activity type
\n","type":"text/plain"},"key":"type","value":"comment"},{"description":{"content":"Sort order
\n","type":"text/plain"},"key":"sort","value":"desc"}],"variable":[{"description":{"content":"Interest Record ID
\n","type":"text/plain"},"type":"any","value":"5048739","key":"id"}]}},"response":[{"id":"cfb9d261-6c87-49b6-9885-6c01c4c5ec5a","name":"Activity Log - Example Response","originalRequest":{"method":"GET","header":[],"url":"/interest/67890/activity"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 98765,\n \"organisation_id\": 789,\n \"disposal_id\": 12345,\n \"interest_id\": 67890,\n \"causer_id\": 456,\n \"activity_type\": \"comment\",\n \"description\": \"Added comment to interest record\",\n \"created_at\": \"2024-01-20T14:45:00Z\"\n },\n {\n \"id\": 98766,\n \"organisation_id\": 789,\n \"disposal_id\": 12345,\n \"interest_id\": 67890,\n \"causer_id\": 456,\n \"activity_type\": \"viewing\",\n \"description\": \"Viewing scheduled\",\n \"created_at\": \"2024-01-22T09:15:00Z\"\n },\n {\n \"id\": 98767,\n \"organisation_id\": 789,\n \"disposal_id\": 12345,\n \"interest_id\": 67890,\n \"causer_id\": 456,\n \"activity_type\": \"status_update\",\n \"description\": \"Interest status updated\",\n \"created_at\": \"2024-01-23T11:30:00Z\"\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total\": 12,\n \"last_page\": 1\n },\n \"links\": {\n \"first\": \"{{landlord_base_url}}/interest/67890/activity?page=1\",\n \"last\": \"{{landlord_base_url}}/interest/67890/activity?page=1\",\n \"prev\": null,\n \"next\": null\n }\n}"}],"_postman_id":"4270750f-7a3a-461b-90c1-d8c61ae04b32"}],"id":"1b911afe-84c6-4c2b-9f23-55ad7720fc0c","description":"Operations related to interest records and schedule matches
\nUse these endpoints to list interest schedules (filter by status, search, and sort, with pagination; disposal_id is optional) and to retrieve a single interest record in full. Records are scoped to your organisation — requesting one you don't own returns 404. Each record carries its status, record owner and acting agency, agent and tenant contact details, comments, requirement values (rent, price, size, tenure, sectors, dates), and viewing progress. From an interest record you can also drill into its activity history.
\n","_postman_id":"1b911afe-84c6-4c2b-9f23-55ad7720fc0c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{client_access_token}}"}]},"isInherited":true,"source":{"_postman_id":"3bec4886-730d-4866-88fc-3990852a41ba","id":"3bec4886-730d-4866-88fc-3990852a41ba","name":"V1","type":"folder"}}}],"id":"3bec4886-730d-4866-88fc-3990852a41ba","description":"Welcome to the Kato Landlord API. This collection provides comprehensive access to landlord-specific functionality within the Kato platform using Postman
\nThe Landlord API enables property landlords to get data updates on disposals, interest schedules, and activity logs through a secure RESTful interface. This API is designed specifically for landlords who need programmatic access to their property portfolio and tenant interest management.
\nThe Landlord API provides access to the following core resources:
\nList Disposals: Paginated access to your property disposals with filtering and sorting
\nShow Disposal: Detailed information for an individual disposal, including property details, pricing, status, assigned agents, and the agencies representing them
\nInterest Schedule Management: View tenant interest for a specific disposal
\nInterest Schedules: Detailed tenant interest tracking with status management, filtering, and pagination
\nInterest Records: Individual interest record management with comprehensive tenant data (scoped to your organisation)
\nDisposal Activities - tracking of actions and changes for a disposal
\nInterest Activities - activity tracking for a specific tenant interest
\n