viewa/docs
API Reference

Get a material

GET
/materials/{ref}

Fetch one material by public id or by a SKU you have registered for it.

Authorization

AuthorizationBearer <token>

Publishable key (browser-safe), sent as Authorization: Bearer pk_…. This is the lower API-key tier and is sufficient for browser-safe routes that require the pk tier. Requests using a publishable key are additionally validated against the key's domain allowlist via the Origin header. Used for upload, areas, renders, polling, catalog reads, and history (history additionally requires a visitor token).

In: header

Path Parameters

ref*string

Either a mat_… public id or a SKU registered for a material on your instance. Resolution follows the same rules as the product ref — a reserved prefix is always read as a public id and never falls back to SKU matching; SKU matching is case-insensitive and ignores surrounding whitespace.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/materials/mat_7Bq2LmZ0xR4vNc9TgWpK"
{  "id": "mat_7Bq2LmZ0xR4vNc9TgWpK",  "name": "Vibe Charcoal",  "description": "string",  "image": {    "url": "https://api.viewa.com/api/media/file/roller-charcoal-512.jpg",    "alt": "Charcoal roller blind"  },  "color": "#3b3b3d",  "categories": [    {      "slug": "roller-blinds",      "name": "Roller Blinds"    }  ]}