# Officeworks Sitemap API Documentation

<p><strong>Officeworks Sitemap API Documentation</strong> Read the public sitemap index or a product sub-sitemap, paged. Product urls expose skus that work unchanged in product, prices, availability, reviews and questions. 1 credit per request. Failed requests are never billed.</p>

- **Documentation:** [https://scrappa.co/docs/officeworks-api/officeworks_sitemap](https://scrappa.co/docs/officeworks-api/officeworks_sitemap)
- **API group:** Officeworks API
- **Endpoint:** `GET https://scrappa.co/api/officeworks/sitemap`

## 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 |
| --- | --- | --- | --- |
| `name` | string | No | Sub-sitemap name or index |
| `page` | integer | No | Zero-based page number |

## Example response

```json
{
    "data": {
        "page": 0,
        "type": "index",
        "count": 5,
        "total": 5,
        "per_page": 200,
        "products": [],
        "sitemaps": [
            {
                "url": "https://www.officeworks.com.au/sitemap-products.xml",
                "name": "sitemap-products"
            }
        ]
    },
    "meta": {
        "credits": 1,
        "billable": true,
        "endpoint_family": "sitemap"
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | Use a sub-sitemap name from the index. Failed requests are 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)
