---
seo:
  description: >-
    The Bolder API is a hypermedia-driven REST API following the HAL (Hypertext
    Application Language) specification.
sidebar:
  label: Overview
title: Bolder API v1
---

[⬇ Download this spec as YAML](/docs/v1/openapi.yaml)

The Bolder API is a hypermedia-driven REST API following the [HAL](https://stateless.group/hal_specification.html)
(Hypertext Application Language) specification.

## HAL conventions

Every response includes a `_links` object with related resources and actions. Links use the `btc:` CURIE
namespace — for example `btc:products` expands to `https://api.onbolder.com/docs/v1#products`.

Non-GET actions (POST, PUT, DELETE) are described by links that carry a `method` property.

Templated links (e.g. pagination, filters) carry `"templated": true` and use RFC 6570 URI Templates.

Embedded sub-resources live in `_embedded` and follow the same HAL structure.

## Paginated results

List endpoints return a paginated results envelope:

```json
{
  "_links": {
    "self": { "href": "…?page=1" },
    "next": { "href": "…?page=2" },
    "last": { "href": "…?page=10" }
  },
  "total_items": 500,
  "per_page": 50,
  "page": 1,
  "_embedded": { "items": [ … ] }
}
```

## Authentication

All requests require a Bearer access token obtained via OAuth 2.0.

```
Authorization: Bearer YOUR-ACCESS-TOKEN
```

See the [Authentication](#tag/Authentication) section for the full list of supported OAuth 2.0 flows.

<ApiOverview source="v1" />

## Root

Entry point that returns the authenticated user's account and linked shops.

<ApiTagOperations source="v1" tag="root" />

## Shops

Shops owned by the authenticated account.

<ApiTagOperations source="v1" tag="shops" />

## Products

Products catalogue management.

<ApiTagOperations source="v1" tag="products" />

## Variants

Product variants (size, colour, etc.).

<ApiTagOperations source="v1" tag="variants" />

## Product Images

Upload and delete product images.

<ApiTagOperations source="v1" tag="product-images" />

## Orders

Order management including creation, updates, and batch operations.

<ApiTagOperations source="v1" tag="orders" />

## Contacts

Shop contacts (customers).

<ApiTagOperations source="v1" tag="contacts" />

## Webhooks

Subscribe to real-time event notifications via webhooks.

<ApiTagOperations source="v1" tag="webhooks" />

## Themes

Shop theme templates and static assets.

<ApiTagOperations source="v1" tag="themes" />