OneRoof Agent API returns an agent profile by numeric id: name, job title, photo, biography, public phone and email, listing and sales statistics, serviced suburbs, skills, awards, testimonial, social links and agency. An unknown id answers 404. Failed requests are not billed.
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.
integer
Required
Required. The numeric agent id (agents[].id) from a search item.
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": 117482,
"bio": "Deliberate, focused, principled; for Chester, real estate is all-consuming.Ask him why, and he\u2019ll tell you it's all about the relationships. For Chester, that means building trust with good people, earned through sound advice, good judgment and dependable action.An integral member o",
"url": "https://www.oneroof.co.nz/agent/chester-duffett-117482",
"name": "Chester Duffett",
"slug": "chester-duffett-117482",
"email": "agent@example.co.nz",
"phone": "021 000 0000",
"photo": "https://s.oneroof.co.nz/image/6d/fe/6dfecbb6f02e24a52d84ab4f2b4977a3.jpg?x-oss-process=image/quality,q_80",
"stats": {
"rating": null,
"sold_total": 12,
"sold_value": null,
"sold_recently": 9,
"days_on_market": null,
"listings_for_sale": 14
},
"awards": [],
"banner": "https://s.oneroof.co.nz/image/9a/01/9a0168ca52acd05f60736ce7377d459f.jpg?x-oss-process=image/quality,q_80",
"office": {
"id": 107,
"name": "Bayleys Real Estate Ltd (Licensed: REAA 2008) - Bayleys, Remuera",
"slug": "bayleys-real-estate-ltd-licensed-reaa-2008-bayleys-remuera-107",
"photo": "https://s.oneroof.co.nz/image/3b/29/3b291efc7b46be09a66f4c4058daf534.jpg?x-oss-process=image/quality,q_80",
"address": "303, Remuera Road, Remuera, Auckland"
},
"skills": [],
"social": [],
"bio_html": "<p>Deliberate, focused, principled; for Chester, real estate is all-consuming.</p><p>Ask him why, and he\u2019ll tell you it's all about the relationships. For Chester, that means building trust with good people, earned through sound advice, good judgment and dependable action.</p><p>An integral member o",
"job_title": "Salesperson",
"video_url": null,
"testimonial": "[{'person': ' ', 'body': 'Chester went above and beyond the call of duty to ensure that our property was very well presented before it went into the market. Throughout the sale campaign, he did not di",
"serviced_suburbs": [
"Remuera",
"Epsom"
]
},
"meta": {
"billable": true,
"endpoint_family": "agent"
},
"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 agent does not exist. This response is not billable.
{
"meta": {
"billable": false,
"retryable": false,
"endpoint_family": "agent"
},
"error": {
"code": "NOT_FOUND",
"message": "The requested record was not found."
},
"success": false
}Upstream Unavailable
OneRoof could not be reached. This response is not billable and is retryable.
{
"meta": {
"billable": false,
"retryable": true,
"endpoint_family": "agent"
},
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "OneRoof 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.