Homes.co.nz Agency API returns the public profile of one agency branch: brand, branch name, logo, phone, email, website, address, coordinates and description. Get the agency id (UUID) from the agency of a search item or listing. An unknown agency is a 404. Failed requests are not billable.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
1 required parameter needed before sending a request.
string
Required
Required. Agency id (UUID) from a search item or listing.
1234567890
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"data": {
"id": "645814a2-983b-49ae-9372-7f58729a7dce",
"url": "https://homes.co.nz/branch/645814a2-983b-49ae-9372-7f58729a7dce",
"logo": "https://trademe.tmcdn.co.nz/tm/property/agent_logos/2436274-8.jpg",
"name": "City",
"about": "The Barfoot & Thompson City Branch is located in a historic building on the corner of Fort and Commerce Streets and behind the Vero building, which serves as a prominent land mark. The office is conveniently located f...",
"brand": "Barfoot & Thompson",
"email": "gsmith@barfoot.co.nz",
"phone": "+64-9-3076340",
"stats": null,
"banner": "https://trademe.tmcdn.co.nz/tm/property/agent_logos/office_branding/2436274-office_branding-1.jpg",
"address": "18 Commerce St\nCity Centre",
"website": "https://www.barfoot.co.nz/branches/city",
"latitude": -36.845954,
"longitude": 174.767671,
"legal_name": null
},
"meta": {
"billable": true,
"endpoint_family": "agency"
},
"success": true
}Errors
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
A parameter is missing or invalid. This response is not billable.
{
"errors": {
"id": [
"The id field is required."
]
},
"message": "The request validation failed"
}Not Found
The agency does not exist. This response is not billable.
{
"meta": {
"billable": false,
"retryable": false,
"endpoint_family": "agency"
},
"error": {
"code": "NOT_FOUND",
"message": "The requested record was not found."
},
"success": false
}Upstream Unavailable
Homes.co.nz could not be reached. This response is not billable and is retryable.
{
"meta": {
"billable": false,
"retryable": true,
"endpoint_family": "agency"
},
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "Homes.co.nz could not be reached. Please retry shortly."
},
"success": false
}Generate Code with AI
Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.
Try It Live
Test this endpoint in our interactive playground with real data.