Listing Search - GET /listings/
\nGet a list of listings based on a range of search criteria.
\nRequest
\nTimestamps included in requests should be in the format YYYY-MM-DD, for example: 2010-12-01 (Date only)
Requested filter parameters are ANDed together to produce the results. Each request parameter may be included only once, except for the following parameters. If a parameter is specified more than once, the values are ORed within that parameter, then ANDed with other parameters:
- \n
id
\n \nlisting_type_id
\n \nlisting_subtype_id
\n \nlisting_no
\n \nval_ref
\n \nagent_id
\n \noffice_id
\n \n
Listings - GET /listings/[listing-id]/
\nRetrieve the details available for a single listing.
\nRequest
\nlisting-id is the ID of the listing to retrieve details for.
Response
\nPlease see example responses.
\nListing Field Descriptions
\nListing id
\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"Agent id
\n","type":"text/plain"},"key":"agent_id","value":""},{"disabled":true,"description":{"content":"Office id
\n","type":"text/plain"},"key":"office_id","value":""},{"disabled":true,"description":{"content":"Agents reference to the listing
\n","type":"text/plain"},"key":"listing_no","value":""},{"disabled":true,"description":{"content":"Listing Status. Default is active.
\n","type":"text/plain"},"key":"listing_status","value":""},{"disabled":true,"description":{"content":"Whether to return all or live listings. Default is true
\n","type":"text/plain"},"key":"live_listings_only","value":""},{"disabled":true,"description":{"content":"Listed after specific date >=
\n","type":"text/plain"},"key":"listed_after","value":"2024-10-01"},{"disabled":true,"description":{"content":"Listed before specific date <
\n","type":"text/plain"},"key":"listed_before","value":"2024-10-01"},{"disabled":true,"description":{"content":"Last changed after a specific date >=
\n","type":"text/plain"},"key":"changed_after","value":"2024-10-01"},{"disabled":true,"description":{"content":"Last changed before a specific date <
\n","type":"text/plain"},"key":"changed_before","value":""},{"disabled":true,"description":{"content":"Valuation reference. Pass the parameter with no value to find entries without val-refs
\n","type":"text/plain"},"key":"val_ref","value":""},{"disabled":true,"description":{"content":"Sort order of results. A \"-\" refix indicates descending order. Default is undefined
\n","type":"text/plain"},"key":"sort_order","value":""},{"disabled":true,"description":{"content":"Maximum number of results to return. Default is 100, Max is 1000
\n","type":"text/plain"},"key":"max_results","value":""},{"disabled":true,"description":{"content":"Zero based offset into the result set. Make sure you pass a sort_order for sane results. Pagination is only supported upto 10000 records
\n","type":"text/plain"},"key":"offset","value":""},{"key":"format","value":"full"},{"key":"api_sig","value":""}],"variable":[]}},"response":[{"id":"7aef6bf6-f16a-437a-97fd-eff54c70f0da","name":"Format = id","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"id","value":"12345678","type":"text"}],"url":{"raw":"https://api.realestate.co.nz/1/listings/?id=12345678&format=id&api_sig=","protocol":"https","host":["api","realestate","co","nz"],"path":["1","listings",""],"query":[{"key":"id","value":"12345678","description":"Listing id"},{"key":"agent_id","value":"","description":"Agent id","disabled":true},{"key":"office_id","value":"","description":"Office id","disabled":true},{"key":"listing_no","value":"","description":"Agents reference to the listing","disabled":true},{"key":"listing_status","value":"","description":"Listing Status. Default is active. ","disabled":true},{"key":"live_listings_only","value":"","description":"Whether to return all or live listings. Default is true","disabled":true},{"key":"listed_after","value":"2024-10-01","description":"Listed after specific date >= ","disabled":true},{"key":"listed_before","value":"2024-10-01","description":"Listed before specific date <","disabled":true},{"key":"changed_after","value":"2024-10-01","description":"Last changed after a specific date >=","disabled":true},{"key":"changed_before","value":"","description":"Last changed before a specific date <","disabled":true},{"key":"val_ref","value":"","description":"Valuation reference. Pass the parameter with no value to find entries without val-refs","disabled":true},{"key":"sort_order","value":"","description":"Sort order of results. A \"-\" refix indicates descending order. Default is undefined","disabled":true},{"key":"max_results","value":"","description":"Maximum number of results to return. Default is 100, Max is 1000","disabled":true},{"key":"offset","value":"","description":"Zero based offset into the result set. Make sure you pass a sort_order for sane results. Pagination is only supported upto 10000 records","disabled":true},{"key":"format","value":"id"},{"key":"api_sig","value":""}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 12345678\n}"},{"id":"8c263006-060d-4c35-9902-9f5b1891b26e","name":"Format = basic","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"id","value":"12345678","type":"text"}],"url":{"raw":"https://api.realestate.co.nz/1/listings/?id=41620443&format=full&api_sig=","protocol":"https","host":["api","realestate","co","nz"],"path":["1","listings",""],"query":[{"key":"id","value":"41620443","description":"Listing id"},{"key":"agent_id","value":"","description":"Agent id","disabled":true},{"key":"office_id","value":"","description":"Office id","disabled":true},{"key":"listing_no","value":"","description":"Agents reference to the listing","disabled":true},{"key":"listing_status","value":"","description":"Listing Status. Default is active. ","disabled":true},{"key":"live_listings_only","value":"","description":"Whether to return all or live listings. Default is true","disabled":true},{"key":"listed_after","value":"2024-10-01","description":"Listed after specific date >= ","disabled":true},{"key":"listed_before","value":"2024-10-01","description":"Listed before specific date <","disabled":true},{"key":"changed_after","value":"2024-10-01","description":"Last changed after a specific date >=","disabled":true},{"key":"changed_before","value":"","description":"Last changed before a specific date <","disabled":true},{"key":"val_ref","value":"","description":"Valuation reference. Pass the parameter with no value to find entries without val-refs","disabled":true},{"key":"sort_order","value":"","description":"Sort order of results. A \"-\" refix indicates descending order. Default is undefined","disabled":true},{"key":"max_results","value":"","description":"Maximum number of results to return. Default is 100, Max is 1000","disabled":true},{"key":"offset","value":"","description":"Zero based offset into the result set. Make sure you pass a sort_order for sane results. Pagination is only supported upto 10000 records","disabled":true},{"key":"format","value":"full"},{"key":"api_sig","value":""}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 41620443,\n \"teaser\": \"Family Home!\",\n \"description\": \"This fully renovated property offers a harmonious combination of flexible living arrangements, space and privacy. Ideal for busy families, multigenerational / blended family living, and co-owners\\nFive double bedrooms with inbuilt wardrobes. Fully equipped kitchen with open plan lounge and dining areas. Three bathrooms and Two laundries. Two heatpumps. Single internal access garage. A lush orchard with an amazing variety of fruit trees. So close to the following:\\n Beach School, College and Shops, Transport, Day Care and Playcentre \\n\",\n \"listing_date\": \"2024-01-08\",\n \"listing_status\": \"active\",\n \"price\": {\n \"tender_date\": null,\n \"auction_date\": null,\n \"price_search\": 1830000,\n \"price_full\": \"Deadline Sale\",\n \"price_gst_included\": true,\n \"price_gst\": \"1830000\",\n \"pricing_method_id\": 7,\n \"price\": 830000,\n \"text_description\": null\n },\n \"address\": {\n \"accuracy\": 10,\n \"text\": [\n \"106T API Lane, Para Beach\",\n \"Paraparaumu Beach\",\n \"Kapiti Coast\",\n \"Wellington 5032\"\n ]\n },\n \"location\": [\n -41.8903851,\n 173.99772\n ],\n \"listing_subtype_id\": 1,\n \"bathrooms\": 3,\n \"bedrooms\": 5,\n \"car_spaces\": 3,\n \"listing_type_id\": 1,\n \"listing_no\": \"TEST001\",\n \"property_id\": null,\n \"url\": \"https://www.realestate.co.nz/41620443/residential/sale/106t-api-lane-paraparaumu-beach-paraparaumu-beach\"\n}"},{"id":"2314c217-c5be-4837-8d43-06c19cb5c60f","name":"Format = full","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://api.realestate.co.nz/1/listings/?id=41620443&format=full&api_sig=","protocol":"https","host":["api","realestate","co","nz"],"path":["1","listings",""],"query":[{"key":"id","value":"41620443","description":"Listing id"},{"key":"agent_id","value":"","description":"Agent id","disabled":true},{"key":"office_id","value":"","description":"Office id","disabled":true},{"key":"listing_no","value":"","description":"Agents reference to the listing","disabled":true},{"key":"listing_status","value":"","description":"Listing Status. Default is active. ","disabled":true},{"key":"live_listings_only","value":"","description":"Whether to return all or live listings. Default is true","disabled":true},{"key":"listed_after","value":"2024-10-01","description":"Listed after specific date >= ","disabled":true},{"key":"listed_before","value":"2024-10-01","description":"Listed before specific date <","disabled":true},{"key":"changed_after","value":"2024-10-01","description":"Last changed after a specific date >=","disabled":true},{"key":"changed_before","value":"","description":"Last changed before a specific date <","disabled":true},{"key":"val_ref","value":"","description":"Valuation reference. Pass the parameter with no value to find entries without val-refs","disabled":true},{"key":"sort_order","value":"","description":"Sort order of results. A \"-\" refix indicates descending order. Default is undefined","disabled":true},{"key":"max_results","value":"","description":"Maximum number of results to return. Default is 100, Max is 1000","disabled":true},{"key":"offset","value":"","description":"Zero based offset into the result set. Make sure you pass a sort_order for sane results. Pagination is only supported upto 10000 records","disabled":true},{"key":"format","value":"full"},{"key":"api_sig","value":""}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 41620443,\n \"teaser\": \"Family Home!\",\n \"description\": \"This fully renovated property offers a harmonious combination of flexible living arrangements, space and privacy. Ideal for busy families, multigenerational / blended family living, and co-owners\\nFive double bedrooms with inbuilt wardrobes. Fully equipped kitchen with open plan lounge and dining areas. Three bathrooms and Two laundries. Two heatpumps. Single internal access garage. A lush orchard with an amazing variety of fruit trees. So close to the following:\\n Beach School, College and Shops, Transport, Day Care and Playcentre \\n\",\n \"updated_date\": \"2024-08-08\",\n \"created_date\": \"2024-08-08\",\n \"listing_date\": \"2024-08-08\",\n \"status_change_date\": \"2024-08-08\",\n \"external_url\": \"https://real.estate/T29903918\",\n \"listing_status\": \"active\",\n \"price\": {\n \"tender_date\": null,\n \"auction_date\": null,\n \"price_search\": 830000,\n \"price_full\": \"Deadline Sale\",\n \"price_gst_included\": true,\n \"price_gst\": \"830000\",\n \"pricing_method_id\": 7,\n \"price\": 830000,\n \"text_description\": null\n },\n \"address\": {\n \"val_ref\": \"\",\n \"street\": \"API Road, Para Beach\",\n \"subpremises\": null,\n \"street_number_text\": \"106T\",\n \"street_number\": \"106T\",\n \"unit\": \"\",\n \"accuracy\": 10,\n \"publish_address\": true,\n \"re_nzfs_suburb_id\": 263,\n \"suburb_id\": 263,\n \"district_id\": 261,\n \"region_id\": 42,\n \"region\": \"Wellington\",\n \"locality\": \"Wellington\",\n \"district\": \"Kapiti Coast\",\n \"suburb\": \"Paraparaumu Beach\",\n \"post_code\": \"5032\",\n \"text\": [\n \"106T API Lane, Para Beach\",\n \"Paraparaumu Beach\",\n \"Kapiti Coast\",\n \"Wellington 5032\"\n },\n \"location\": [\n -41.8903851,\n 173.99772\n ],\n \"listing_subtype_id\": 1,\n \"bathrooms\": 3,\n \"bedrooms\": 4,\n \"car_spaces\": 3,\n \"floor_area\": 177,\n \"listing_type_id\": 1,\n \"listing_no\": \"TEST001\",\n \"property_id\": null,\n \"url\": \"https://www.realestate.co.nz/41620443/residential/sale/106t-api-lane-paraparaumu-beach-paraparaumu-beach\",\n \"images_md5\": [\n \"1939a2cc1786a9e31282d77dec95a4be\",\n \"f43cb9f556b836003c36b224cec82383\",\n \"caf1ad6e5faa83fb14939a15840181b5\"\n ],\n \"images\": [\n \"https://images16.realestate.co.nz/listings/41620443/1939a2cc1786a9e31282d77dec95a4be\",\n \"https://images16.realestate.co.nz/listings/41620443/f43cb9f556b836003c36b224cec82383\",\n \"https://images16.realestate.co.nz/listings/41620443/caf1ad6e5faa83fb14939a15840181b5\",\n ],\n \"offices\": [\n {\n \"street_address\": {\n \"country\": null,\n \"postcode\": \"5032\",\n \"address\": [\n \"Coastlands Parade\",\n null,\n \"Paraparaumu\"\n ]\n },\n \"logo_md5\": \"041f1a8f2c43f4d5d05b3fb15e5b9681\",\n \"logo\": \"https://images16.realestate.co.nz/pid/1234/\",\n \"website\": \"http://www.real.estate.co.nz\",\n \"email\": \"paraparaumu@real.estate.co.nz\",\n \"phone\": \"04 000 0000\",\n \"name\": \"Team Real Estate Ltd (Licensed: REAA 2008)\",\n \"id\": 1234\n }\n ],\n \"features\": [\n {\n \"category\": \"Other Features\",\n \"description\": \"2 x Wall Heaters\"\n }\n ]\n }\n}"}],"_postman_id":"5172682e-06cc-4166-964f-97a96e829710"},{"name":"Offices","event":[{"listen":"test","script":{"id":"9716a402-df6c-409f-8bdc-e15733ac4e5a","exec":[""],"type":"text/javascript","packages":{}}}],"id":"0e2631ea-d3d0-4c99-8320-918263e0281c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api_key"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.realestate.co.nz/1/offices/?format=full&api_sig","description":"Office Search - GET /offices/
\nGet a list of offices based on a range of search criteria.
\nRequest
\nRequested filter parameters are ANDed together to produce the results. Each request parameter may be included only once, except for the following parameters. If a parameter is specified more than once, the values are ORed within that parameter, then ANDed with other parameters: * office_id * office_code
Response
\nmore indicates whether there are additional results available by re-querying with offset=([current-offset] + max_results).
count is the total number of records matching the search, regardless of the max_results parameter.
Office - GET /offices/[office-id]/
\nRetrieve the details for a single office.
\nRequest
\nSupply the office-id in the url.
Response
\nWhere format = id.
{\n id: 1234,\n code: \"92546-A\"\n} \n\nWhere format = full.
{\n \"id\": 105,\n \"parent_id\": null,\n \"code\": \"92546-A\",\n \"name\": \"TestAgents Ltd (Licensed: REAA 2008) - Real Estate, Auckland\",\n \"brand_name\": \"Test Agents \",\n \"email\": \"test@realestate.co.nz\",\n \"image\": null,\n \"website\": \"https://www.realestate.co.nz/\",\n \"office_status\": \"active\",\n \"phone_numbers\": {\n \"phone\": \"09 123 0007\",\n \"fax\": \"09 123 0008\",\n \"rentals_ddi\": \"09 123 0007\"\n },\n \"addresses\": {\n \"street\": {\n \"location\": [-57.685638, 186.168246],\n \"postcode\": null,\n \"city\": \"Auckland\",\n \"address_line_3\": \"\",\n \"address_line_2\": \"\",\n \"address_line_1\": \"155 Khyber Pass Road\"\n },\n \"postal\": {\n \"postcode\": null,\n \"city\": \"Auckland\",\n \"address_line_3\": \"\",\n \"address_line_2\": \"\",\n \"address_line_1\": \"155 Khyber Pass Road\"\n }\n }\n}\n\nOffice Field Descriptions
\n","urlObject":{"protocol":"https","path":["1","offices",""],"host":["api","realestate","co","nz"],"query":[{"disabled":true,"description":{"content":"Office short code
\n","type":"text/plain"},"key":"office_code","value":""},{"disabled":true,"description":{"content":"Office id
\n","type":"text/plain"},"key":"office_id","value":""},{"disabled":true,"description":{"content":"Maximum results to return. Default is 10, max is 1000
\n","type":"text/plain"},"key":"max_results","value":""},{"disabled":true,"description":{"content":"Zero based offset into the result set
\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"How much detail to return about an office. Default is id
\n","type":"text/plain"},"key":"format","value":"full"},{"disabled":true,"description":{"content":"Defaults to return only active offices
\n","type":"text/plain"},"key":"office_status","value":""},{"description":{"content":"Calcaluted API signature
\n","type":"text/plain"},"key":"api_sig","value":null}],"variable":[]}},"response":[{"id":"3bcd6c91-9d8b-4e51-bc5d-56a93d16b803","name":"Format = id","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://api.realestate.co.nz/1/offices/?office_id=1234&format=id&api_sig","protocol":"https","host":["api","realestate","co","nz"],"path":["1","offices",""],"query":[{"key":"office_code","value":"","description":"Office short code","disabled":true},{"key":"office_id","value":"1234","description":"Office id"},{"key":"max_results","value":"","description":"Maximum results to return. Default is 10, max is 1000","disabled":true},{"key":"offset","value":"","description":"Zero based offset into the result set","disabled":true},{"key":"format","value":"id","description":"How much detail to return about an office. Default is id"},{"key":"office_status","value":"","description":"Defaults to return only active offices","disabled":true},{"key":"api_sig","value":null,"description":"Calcaluted API signature"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n id: 1234,\r\n code: \"92546-A\"\r\n}"},{"id":"70ed125e-5363-419d-885c-5db2b859177b","name":"Format = full","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://api.realestate.co.nz/1/offices/?office_id=1234&format=full&api_sig","protocol":"https","host":["api","realestate","co","nz"],"path":["1","offices",""],"query":[{"key":"office_code","value":"","description":"Office short code","disabled":true},{"key":"office_id","value":"1234","description":"Office id"},{"key":"max_results","value":"","description":"Maximum results to return. Default is 10, max is 1000","disabled":true},{"key":"offset","value":"","description":"Zero based offset into the result set","disabled":true},{"key":"format","value":"full","description":"How much detail to return about an office. Default is id"},{"key":"office_status","value":"","description":"Defaults to return only active offices","disabled":true},{"key":"api_sig","value":null,"description":"Calcaluted API signature"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 105,\r\n \"parent_id\": null,\r\n \"code\": \"92546-A\",\r\n \"name\": \"TestAgents Ltd (Licensed: REAA 2008) - Real Estate, Auckland\",\r\n \"brand_name\": \"Test Agents \",\r\n \"email\": \"test@realestate.co.nz\",\r\n \"image\": null,\r\n \"website\": \"https://www.realestate.co.nz/\",\r\n \"office_status\": \"active\",\r\n \"phone_numbers\": {\r\n \"phone\": \"09 123 0007\",\r\n \"fax\": \"09 123 0008\",\r\n \"rentals_ddi\": \"09 123 0007\"\r\n },\r\n \"addresses\": {\r\n \"street\": {\r\n \"location\": [\r\n -57.685638,\r\n 186.168246\r\n ],\r\n \"postcode\": null,\r\n \"city\": \"Auckland\",\r\n \"address_line_3\": \"\",\r\n \"address_line_2\": \"\",\r\n \"address_line_1\": \"155 Khyber Pass Road\"\r\n },\r\n \"postal\": {\r\n \"postcode\": null,\r\n \"city\": \"Auckland\",\r\n \"address_line_3\": \"\",\r\n \"address_line_2\": \"\",\r\n \"address_line_1\": \"155 Khyber Pass Road\"\r\n }\r\n }\r\n}"}],"_postman_id":"0e2631ea-d3d0-4c99-8320-918263e0281c"},{"name":"Agents","event":[{"listen":"test","script":{"id":"dd5ef79e-d187-4ff9-bb4e-6f66de6f4c0c","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"f2aabf86-74ea-49b8-a30e-e53019c5ccaf","exec":[""],"type":"text/javascript","packages":{}}}],"id":"ecfe8975-2039-452d-81fa-09c0e06c9e3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api_key"},{"key":"value","value":"Agent Search - GET /agents/
\nGet a list of agents based on a range of search criteria.
\nRequest
\n| agent_status | [all,active] | No | All does not return inactive agents for subscriber key need to check for other key types |
Requested filter parameters are ANDed together to produce the results. Each request parameter may be included only once, except for the following parameters. If a parameter is specified more than once, the values are ORed within that parameter, then ANDed with other parameters: * agent_id * office_id * agent_code * region_id * district_id * suburb_id *
Response
\nmore indicates whether there are additional results available by re-querying with offset=([current-offset] + max_results).
count is the total number of records matching the search, regardless of the max_results parameter.
Agent - GET /agents/[agent-id]/
\nRetrieve the details for a single agent.
\nRequest
\nSupply the agent-id in the url.
Response
\nWhere format = id.
{\n id: 12345,\n code: \"BFT_1234\"\n} \n\nWhere format = full.
{\n \"id\": 12345,\n \"code\": \"BFT_123\",\n \"title\": null,\n \"first_name\": \"Test\",\n \"last_name\": \"Agent\",\n \"login\": \"test.agent@realestate.co.nz\",\n \"primary_class_code\": \"REP\",\n \"primary_job_title\": null,\n \"image\": \"34ba0f48a7e69d7f0ebc80f69f21fced\",\n \"agent_status\": \"active\",\n \"bio\": \"Allow myself to introduce myself...\", \n \"addresses\": {\n \"postal\": {\n \"address_line_1\": null,\n \"address_line_2\": null,\n \"address_line_3\": null,\n \"city\": null,\n \"postcode\": null\n },\n \"street\": {\n \"address_line_1\": null,\n \"address_line_2\": null,\n \"address_line_3\": null,\n \"city\": null,\n \"postcode\": null\n }\n },\n \"phone_numbers\": {\n \"office_ddi\": \"09 000 0000\",\n \"mobile\": \"020 000 0000\"\n },\n \"email_addresses\": {\n \"contact\": \"test.agent@realestate.co.nz\",\n \"enquiries\": \"test.agent@realestate.co.nz\",\n \"other-email\": \"test.agent@realestate.co.nz\"\n },\n \"links\": {\n \"website\": \"steve.tinyhomes.co.nz\",\n \"blog\": \"voices.realestate.co.nz/tinysteve\",\n \"linked_in\": \"www.linkedin.com/in/tinysteve\",\n \"facebook_profile\": \"https://www.facebook.com/profile\"\n \"relationships\": [\n {\n \"is_primary\": true,\n \"primary_job_title\": \"Licensee Salesperson\",\n \"primary_class_code\": \"REP\",\n \"office_id\": 98765\n },\n {\n \"is_primary\": false,\n \"primary_job_title\": \"Licensee Salesperson\",\n \"primary_class_code\": \"REP\",\n \"office_id\": 23456\n }\n ]\n}\n\nAgent Field Descriptions
\n","urlObject":{"protocol":"https","path":["1","agents",""],"host":["api","realestate","co","nz"],"query":[{"disabled":true,"description":{"content":"Agent ID
\n","type":"text/plain"},"key":"agent_id","value":""},{"disabled":true,"description":{"content":"Office ID
\n","type":"text/plain"},"key":"office_id","value":""},{"disabled":true,"description":{"content":"External Agent Code
\n","type":"text/plain"},"key":"code","value":""},{"disabled":true,"description":{"content":"Returns agents changed after a certain time. Format - mm-dd-yyyy
\n","type":"text/plain"},"key":"changed_after","value":""},{"disabled":true,"description":{"content":"Maximum number of results to return. Default is 10
\n","type":"text/plain"},"key":"max_results","value":""},{"disabled":true,"description":{"content":"Zero based offset into the result set
\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"How much detail to return about an agent. id or full. Default is id
\n","type":"text/plain"},"key":"format","value":"full"},{"disabled":true,"description":{"content":"All or active. Default is active
\n","type":"text/plain"},"key":"agent_status","value":""},{"description":{"content":"Calcaluted API signature
\n","type":"text/plain"},"key":"api_sig","value":""}],"variable":[]}},"response":[{"id":"25e8143c-db46-4d70-8022-ace1e34e507f","name":"Format = id","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.realestate.co.nz/1/agents/?agent_id=12345&format=id&api_sig=","protocol":"https","host":["api","realestate","co","nz"],"path":["1","agents",""],"query":[{"key":"agent_id","value":"12345","description":"Agent ID"},{"key":"office_id","value":"","description":"Office ID","disabled":true},{"key":"code","value":"","description":"External Agent Code","disabled":true},{"key":"changed_after","value":"","description":"Returns agents changed after a certain time. Format - mm-dd-yyyy","disabled":true},{"key":"max_results","value":"","description":"Maximum number of results to return. Default is 10","disabled":true},{"key":"offset","value":"","description":"Zero based offset into the result set","disabled":true},{"key":"format","value":"id","description":"How much detail to return about an agent. id or full. Default is id"},{"key":"agent_status","value":"","description":"All or active. Default is active","disabled":true},{"key":"api_sig","value":"","description":"Calcaluted API signature"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n id: 12345,\r\n code: \"BFT_1234\"\r\n}"},{"id":"940b4c3b-4439-4f35-95f3-96f90a5513b0","name":"Format = full","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.realestate.co.nz/1/agents/?agent_id=12345&format=full&api_sig=","protocol":"https","host":["api","realestate","co","nz"],"path":["1","agents",""],"query":[{"key":"agent_id","value":"12345","description":"Agent ID"},{"key":"office_id","value":"","description":"Office ID","disabled":true},{"key":"code","value":"","description":"External Agent Code","disabled":true},{"key":"changed_after","value":"","description":"Returns agents changed after a certain time. Format - mm-dd-yyyy","disabled":true},{"key":"max_results","value":"","description":"Maximum number of results to return. Default is 10","disabled":true},{"key":"offset","value":"","description":"Zero based offset into the result set","disabled":true},{"key":"format","value":"full","description":"How much detail to return about an agent. id or full. Default is id"},{"key":"agent_status","value":"","description":"All or active. Default is active","disabled":true},{"key":"api_sig","value":"","description":"Calcaluted API signature"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 12345,\r\n \"code\": \"BFT_123\",\r\n \"title\": null,\r\n \"first_name\": \"Test\",\r\n \"last_name\": \"Agent\",\r\n \"login\": \"test.agent@realestate.co.nz\",\r\n \"primary_class_code\": \"REP\",\r\n \"primary_job_title\": null,\r\n \"image\": \"34ba0f48a7e69d7f0ebc80f69f21fced\",\r\n \"agent_status\": \"active\",\r\n \"bio\": \"Allow myself to introduce myself...\", \r\n \"addresses\": {\r\n \"postal\": {\r\n \"address_line_1\": null,\r\n \"address_line_2\": null,\r\n \"address_line_3\": null,\r\n \"city\": null,\r\n \"postcode\": null\r\n },\r\n \"street\": {\r\n \"address_line_1\": null,\r\n \"address_line_2\": null,\r\n \"address_line_3\": null,\r\n \"city\": null,\r\n \"postcode\": null\r\n }\r\n },\r\n \"phone_numbers\": {\r\n \"office_ddi\": \"09 000 0000\",\r\n \"mobile\": \"020 000 0000\"\r\n },\r\n \"email_addresses\": {\r\n \"contact\": \"test.agent@realestate.co.nz\",\r\n \"enquiries\": \"test.agent@realestate.co.nz\",\r\n \"other-email\": \"test.agent@realestate.co.nz\"\r\n },\r\n \"links\": {\r\n \"website\": \"steve.tinyhomes.co.nz\",\r\n \"blog\": \"voices.realestate.co.nz/tinysteve\",\r\n \"linked_in\": \"www.linkedin.com/in/tinysteve\",\r\n \"facebook_profile\": \"https://www.facebook.com/profile\"\r\n \"relationships\": [\r\n {\r\n \"is_primary\": true,\r\n \"primary_job_title\": \"Licensee Salesperson\",\r\n \"primary_class_code\": \"REP\",\r\n \"office_id\": 98765\r\n },\r\n {\r\n \"is_primary\": false,\r\n \"primary_job_title\": \"Licensee Salesperson\",\r\n \"primary_class_code\": \"REP\",\r\n \"office_id\": 23456\r\n }\r\n ]\r\n}"}],"_postman_id":"ecfe8975-2039-452d-81fa-09c0e06c9e3c"}],"auth":{"type":"apikey","apikey":{"basicConfig":[]}},"event":[{"listen":"prerequest","script":{"id":"f0cdbb14-210b-4435-bca7-8b684c5e3558","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"97c2692e-9e7a-4634-a742-b97d368ad683","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://api.realestate.co.nz/1/"}]}