Rumah123 Agencies API finds agencies by name. Each result has the agency id, name, profile URL and the office location. The pagination block shows the total number of matches and pages. A name with no match returns an empty list, which is a valid, billed answer.
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.
2 optional filters available.
string
Required
Agency name, 2 to 100 characters. Example: ray white.
coffee shops
integer
Optional
One-based page number. Default 1.
1
integer
Optional
Results per page, 1 to 50. Default 20.
10
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"data": {
"items": [
{
"id": "19226",
"url": "https://www.rumah123.com/en/property-agent/ray-white-19226/",
"name": "Ray White",
"uuid": "07d861e9-81b4-4955-baed-50bfc2f71543",
"location": "Sudirman, Jakarta Selatan"
},
{
"id": "36852",
"url": "https://www.rumah123.com/en/property-agent/ray-white-depok-36852/",
"name": "Ray White Depok",
"uuid": "19aa47aa-6916-4d17-ae14-ab9110371773",
"location": "Margonda, Depok"
}
],
"pagination": {
"per_page": 20,
"page_count": 11,
"total_count": 205,
"current_page": 1
}
},
"meta": {
"billable": true,
"endpoint_family": "agencies"
},
"success": true
}Errors
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
A required parameter or a range is invalid. This response is not billable.
{
"errors": {
"query": [
"The query field is required."
]
},
"message": "The request validation failed"
}Upstream Unavailable
Rumah123 could not be reached or returned data that does not match the request. This response is not billable and is retryable.
{
"meta": {
"billable": false,
"retryable": true,
"endpoint_family": "agencies"
},
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "Rumah123 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.