# realestate.co.nz Office Profile API Documentation

Retrieve a public office profile by office id: name, colloquial name, phone, fax, email, logo, brand colour, addresses, coordinates, listing counts, categories, areas and the agents of the office. Office ids come from the office field of a listing.

- **Documentation:** [https://scrappa.co/docs/realestate-co-nz-api/realestate_co_nz_office](https://scrappa.co/docs/realestate-co-nz-api/realestate_co_nz_office)
- **API group:** realestate.co.nz API
- **Endpoint:** `GET https://scrappa.co/api/realestate-co-nz/office`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | integer | Yes | Numeric office id from a listing, e.g. 231240. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/realestate-co-nz/office?id=231240"
```

## Example response

```json
{
    "success": true,
    "data": {
        "office": {
            "id": 231240,
            "name": "Bayleys Real Estate Ltd (Licensed: REAA 2008) - Pukekohe",
            "colloquial_name": "Bayleys - Pukekohe",
            "slug": "bayleys-real-estate-ltd-licensed-reaa-2008-pukekohe",
            "phone": "021 000 000",
            "email": "agent@example.co.nz",
            "logo_url": "https://mediaserver.realestate.co.nz/per_orgs/231240/317fb1fad9daaf5bd0f93986120e4ebe.jpg",
            "brand_colour": "#00263A",
            "listing_count": 200,
            "fax": "09 239 2508",
            "postal_address": {
                "address": "Po Box 72-046",
                "city": "PAPAKURA",
                "country": "New Zealand"
            },
            "physical_address": {
                "address": "8 Massey Ave",
                "city": "PUKEKOHE",
                "country": "New Zealand"
            },
            "latitude": -37.2021333,
            "longitude": 174.9060217,
            "listing_total_count": 2775,
            "listing_recent_count": 368,
            "active_listings_by_category": {
                "res_sale": 143,
                "rural_sale": 46,
                "com_lease": 5,
                "biz_sale": 4,
                "com_sale": 2
            },
            "categories": [
                "res_sale",
                "com_sale"
            ],
            "suburbs": [
                "Karaka",
                "Papakura"
            ],
            "is_property_manager": false,
            "is_business_broker": false,
            "agents": [
                {
                    "id": 639072,
                    "name": " ",
                    "phone": "021 000 000",
                    "email": "agent@example.co.nz",
                    "image": {
                        "url": "https://mediaserver.realestate.co.nz/per_orgs/639072/f06bf4b449813821b785ce52adb3801b.jpg",
                        "thumbnail_url": "https://mediaserver.realestate.co.nz/per_orgs/639072/f06bf4b449813821b785ce52adb3801b.crop.31x40.jpg",
                        "medium_url": "https://mediaserver.realestate.co.nz/per_orgs/639072/f06bf4b449813821b785ce52adb3801b.crop.105x134.jpg",
                        "large_url": "https://mediaserver.realestate.co.nz/per_orgs/639072/f06bf4b449813821b785ce52adb3801b.crop.140x178.jpg"
                    },
                    "office_name": "Bayleys Real Estate Ltd (Licensed: REAA 2008) - Pukekohe",
                    "listing_count": 13
                },
                {
                    "id": 202077,
                    "name": " ",
                    "phone": "021 000 000",
                    "email": "agent@example.co.nz",
                    "image": {
                        "url": "https://mediaserver.realestate.co.nz/per_orgs/202077/da44b84eda350e1cf7671cd6b6c38f08.jpg",
                        "thumbnail_url": "https://mediaserver.realestate.co.nz/per_orgs/202077/da44b84eda350e1cf7671cd6b6c38f08.crop.31x40.jpg",
                        "medium_url": "https://mediaserver.realestate.co.nz/per_orgs/202077/da44b84eda350e1cf7671cd6b6c38f08.crop.105x134.jpg",
                        "large_url": "https://mediaserver.realestate.co.nz/per_orgs/202077/da44b84eda350e1cf7671cd6b6c38f08.crop.140x178.jpg"
                    },
                    "office_name": "Bayleys Real Estate Ltd (Licensed: REAA 2008) - Pukekohe",
                    "listing_count": 0
                }
            ]
        }
    },
    "meta": {
        "endpoint_family": "office",
        "billable": true
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
|  | Error | page times rows is above 10000. Narrow the search. Not billed. |
|  | Error | The listing, agent or office does not exist. Not billed. |
|  | Error | realestate.co.nz could not be reached. Not billed. |
|  | Error | realestate.co.nz refused the request. Not billed. |
|  | Error | The upstream service is temporarily unavailable. Please retry shortly. |
|  | Error | realestate.co.nz returned an unexpected payload shape. Not billed. |
|  | Error | realestate.co.nz rejected the request parameters. Not billed. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)