For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Getting Started
Onboarding & Plans
Tenancy & Governance
Authoring Studios
Product Module
Localisations
Domains & Custom Hostnames
Passports
Passport Intelligence
Minting
API Reference

API Reference OpenAPI Products

List products

GET

https://api.tieback.io/v1/products

GET

/v1/products

$ curl https://api.tieback.io/v1/products \
>      -H "x-workspace-id: x-workspace-id" \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "ok": true,
3   "data": [
4     {
5       "id": "a3f1c9d2-4b7e-4f8a-9c3d-2e5f7b8a1c9d",
6       "name": "Eco-Friendly Water Bottle",
7       "sku": "ECO-WB-001",
8       "description": "Reusable stainless steel water bottle with bamboo lid",
9       "category": "Outdoor Gear",
10       "price": 24.99,
11       "currency": "USD",
12       "available": true,
13       "createdAt": "2024-05-10T09:15:00Z",
14       "updatedAt": "2024-06-01T12:00:00Z"
15     }
16   ],
17   "meta": {
18     "page": 1,
19     "pageSize": 10,
20     "totalPages": 5,
21     "totalItems": 45
22   }
23 }

Returns a paginated list of products for the workspace.

Was this page helpful?

Create product

Authentication

AuthorizationBearer

User session token from tieback authentication

OR

x-api-keystring

Machine-to-machine API key (scoped permissions)

Headers

x-workspace-idstringRequiredformat: "uuid"

Target workspace/brand ID

x-request-idstringOptionalformat: "uuid"

Client-provided correlation ID (auto-generated if missing)

Response

OK

okboolean

datalist of objects

metaobject