{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"6efe62f9-87dc-4c9e-9518-affe7c49d067","name":"API","description":"> This API is built and maintained by **Realty Assist Australia Limited**.  \nFor assistance with the API integration, feel free to contact us at [integrations@realtyassist.com.au](https://) or call us on [1300 355 729](https://). \n  \n\n---\n\nThis API is designed for CRM platforms to provide a seamless integration for real estate businesses that are registered with Realty Assist Australia to replicate the core functionalities available on our web application.\n\n<img src=\"https://content.pstmn.io/b4f9f69e-c123-49d1-8e8b-5b2767499978/cG9zdG1hbi1hcGkuZHJhd2lvLnBuZw==\" alt=\"RealtyAssist%20/%20Integration%20Partner\">\n\n---\n\n### Navigating the documentation\n\nFor ease of reference, the _Getting Started_ section follows this one. However, we strongly recommend reviewing the entire _Introduction_ piece before proceeding.\n\nUsing Postman for API testing and exploration can simplify your integration process. This collection offers pre-defined examples, pre-configured environment variables, and automated workflows. Tasks like setting the `access_token` and `refresh_token` are handled automatically for you.\n\nWhen referring to words starting with a capital letter, such as \"Location\", \"Property, and \"Media,\" the mention is towards the model name and not the common noun. All models are under the **Models** folder.\n\nThroughout this documentation, the term \"RA Engine\" denotes the central component responsible for driving RealtyAssist's core system. The \"Customer Portal\" pertains to the B2C web application, whereas the \"Agency Portal\" relates to the B2B web application. When mentioning \"RealtyAssist,\" it encompasses the entire core system. On the other hand, when mentioning \"Realty Assist Australia Limited,\" it specifically refers to the business entity.\n\n---\n\n### Getting started\n\n#### 1 · Prerequisites\n\nYou will need a designated **Client ID** and **Client Secret** to begin the integration process. If you haven't already, kindly contact us at [integrations@realtyassist.com.au](https://) so we can provide them to you.\n\n#### 2 · Fork the collection\n\nSimply click the _Run in Postman_ button in the top-right corner of the API documentation. You'll then be prompted to choose a workspace to fork the collection.\n\n<img src=\"https://content.pstmn.io/a42b33d0-e19b-46f0-a1cc-88ae44a70007/U2NyZWVuc2hvdCAyMDIzLTA3LTE3IGF0IDEwLjE4LjQwIHBtLnBuZw==\" width=\"274\" height=\"124\">\n\n#### 3 · Set environment variables\n\nThis Postman collection includes a pre-configured environment: `API (public)`.  \nYou will need to set up the following environment variables to use the Postman collection. Ensure that the Initial and Current values are filled with their respective values.\n\n<img src=\"https://content.pstmn.io/cb3f3074-07ca-4184-aac5-47b0db549126/U2NyZWVuc2hvdCAyMDIzLTA3LTIyIGF0IDYuNTkuNDcgcG0ucG5n\" alt=\"Environment%20variables%20in%20Postman\">\n\n| Name | Description |\n| --- | --- |\n| `CLIENT_ID` | Your designated **Client ID**. |\n| `CLIENT_SECRET` | Your designated **Client Secret**. |\n| `CODE` | The code returned from the **Request Authorisation** endpoint. |\n| `REDIRECT_URI` | The URL where users are redirected after successful authentication. |\n\nⓘ **Information**\n\nThe variables `ACCESS_TOKEN` and `REFRESH_TOKEN` will automatically be populated in Postman when triggering the **Request Token** or **Refresh Token** endpoints.\n\n---\n\n### Environments\n\nYou can access this API in our Sandbox and Production environments. However, please note that the former is intended solely for testing purposes.\n\n**API Base URL**\n\nThis is the base URL to use for every API endpoint.\n\n| **Environment** | **URL** |\n| --- | --- |\n| Sandbox | [https://sandbox-api.realtyassist.com.au](https://sandbox-api.realtyassist.com.au) |\n| Production | [https://api.realtyassist.com.au](https://api.realtyassist.com.au) |\n\n**Customer Portal**\n\nThis is the web application where customers (e.g., vendors, buyers, tenants) manage and pay their invoices and loans.\n\n| **Environment** | **URL** |\n| --- | --- |\n| Sandbox | [https://sandbox-pay.realtyassist.com.au](https://sandbox-pay.realtyassist.com.au) |\n| Production | [https://pay.realtyassist.com.au](https://pay.realtyassist.com.au) |\n\n**Agency Portal**\n\nThis is the web application where real estate representatives manage their customers, fund requests, transactions and more.\n\n| **Environment** | **URL** |\n| --- | --- |\n| Sandbox | [https://sandbox-app.realtyassist.com.au](https://) |\n| Production | [https://app.realtyassist.com.au](https://) |\n\n---\n\n### Glossary\n\n| **Term** | **Definition** |\n| --- | --- |\n| Location | The term `Location` is used interchangeably with the term `Office`.  <br>A Location refers to an entity that groups together representatives under the same business. Representatives may have access to multiple Locations. |\n| Representative | `Representative` is one of the two types of users. A representative has access to the Agency Portal, where they can manage their fund requests, customers and more. |\n| Customer | `Customer` is one of the two types of users. A customer has access to the Customer Portal, where they can view and pay their invoices. |\n\n---\n\n### API usage\n\n#### Standards\n\nThe following rules are enforced across all API endpoints:\n\n- All amounts are denoted in Australian cents.\n    \n- All enums follow the `UPPER_SNAKE_CASE` naming convention.\n    \n- Unless specified with timezones, all date values are referenced to Perth time (GMT+8).\n    \n\n#### Specifications\n\nThis API employs the OAuth 2.0 industry-standard protocol for authorisation and complies with the JSON:API version 1.0 Specification for all endpoints under the **Models** folder.\n\n#### Limits\n\nThis API imposes a restriction of 100 requests per minute. Exceeding this limit will lead to receiving a 429 HTTP error in response. If there is a possibility that you might surpass this limit, please get in touch with us.\n\n#### Error responses\n\nWith the exception of API endpoints that do not return any content (i.e., `204 No Content`), all errors received from this API will adhere to a schema resembling the following example:\n\n``` json\n{\n    \"errors\": [\n        {\n            \"detail\": \"The terms field is required.\",\n            \"source\": {\n                \"pointer\": \"/data/terms\"\n            },\n            \"status\": \"422\",\n            \"title\": \"Unprocessable Entity\"\n        }\n    ]\n}\n\n ```\n\nIf our system encounters an unhandled error, it will generate an `incident` ID and include it within the `meta` object. To ensure improved support, we kindly request that you communicate this incident ID to us in such circumstances.\n\n``` json\n{\n    \"errors\": [\n        // ...\n    ],\n    \"meta\": {\n        \"incident\": \"273eddfa-4ab0-407e-88ba-0dae935478e2\"\n    }\n}\n\n ```\n\nThe most common API error responses are outlined below:\n\n| **Status** | **Title** | **Detail** |\n| --- | --- | --- |\n| **401** | `Unauthorized` | The user has not been authorised to use the API endpoint. |\n| **403** | `Forbidden` | Access to the requested resource or endpoint is forbidden. |\n| **404** | `Not Found` | The requested resource or endpoint does not exist. |\n| **405** | `Method Not Allowed` | The endpoint does not support the request method. |\n| **415** | `Unsupported Media Type` | The endpoint does not support the request headers. |\n| **422** | `Unprocessable Entity` | The request data is invalid. See errors object in response for specific details. |\n| **429** | `Too Many Requests` | The number of requests sent through the API reached the API limit. |\n\n---\n\n### Integration example\n\nBelow is Postman Flow to illustrate how to utilise the various API endpoints to generate a new Fund Request.\n\n<img src=\"https://content.pstmn.io/e6024ba2-5419-4556-8219-c8811be8b2f5/U2NyZWVuc2hvdCAyMDIzLTA3LTIyIGF0IDcuMDQuMTkgcG0ucG5n\" alt=\"Fund%20Request%20creation%20flow\">","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"19227748","collectionId":"6efe62f9-87dc-4c9e-9518-affe7c49d067","publishedId":"2s93Jxpzrr","public":true,"publicUrl":"https://postman.realtyassist.com.au","privateUrl":"https://go.postman.co/documentation/19227748-6efe62f9-87dc-4c9e-9518-affe7c49d067","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"002855"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"This API is designed for CRM platforms to provide a seamless integration for real estate businesses that are registered with Realty Assist Australia to replicate the core functionalities available on our web application."},{"name":"title","value":"API | Realty Assist Australia"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/10fd58c9-e252-4b14-ace8-aa285c4db125/UkxULUxPR09NQVJLLURJR0lUQUwtQ1JFTUEucG5n","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"ef6a00"}},{"name":"light","logo":"https://content.pstmn.io/5b63b3e0-affe-47fa-b1d7-7e44c8a2ff87/UkxULUxPR09NQVJLLURJR0lUQUwtSU5LLnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"002855"}}]}},"version":"8.10.1","publishDate":"2023-11-04T06:36:07.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"API | Realty Assist Australia","description":"This API is designed for CRM platforms to provide a seamless integration for real estate businesses that are registered with Realty Assist Australia to replicate the core functionalities available on our web application."},"logos":{"logoLight":"https://content.pstmn.io/5b63b3e0-affe-47fa-b1d7-7e44c8a2ff87/UkxULUxPR09NQVJLLURJR0lUQUwtSU5LLnBuZw==","logoDark":"https://content.pstmn.io/10fd58c9-e252-4b14-ace8-aa285c4db125/UkxULUxPR09NQVJLLURJR0lUQUwtQ1JFTUEucG5n"}},"statusCode":200},"environments":[{"name":"API (public)","id":"7d3a3c84-8d04-4589-aaa3-ce2fa227e949","owner":"19227748","values":[{"key":"API_BASE_URL","value":"https://sandbox-api.realtyassist.com.au","enabled":true,"type":"default"},{"key":"CLIENT_ID","value":"","enabled":true,"type":"secret"},{"key":"CLIENT_SECRET","value":"","enabled":true,"type":"secret"},{"key":"REDIRECT_URI","value":"https://example.com/oauth/callback","enabled":true,"type":"default"},{"key":"CODE","value":"","enabled":true,"type":"secret"},{"key":"ACCESS_TOKEN","value":"","enabled":true,"type":"secret"},{"key":"REFRESH_TOKEN","value":"","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://realtyassist.com.au/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":"API (public)","value":"19227748-7d3a3c84-8d04-4589-aaa3-ce2fa227e949"}],"canonicalUrl":"https://postman.realtyassist.com.au/view/metadata/2s93Jxpzrr"}