StoreBay Developers
Catalogue

Retrieve an unit type

GET
/unit-types/{id}

Authorization

AuthorizationBearer <token>

Present an API key (sb_live_… / sb_test_…), an OAuth2 access token, or a static token as a Bearer credential. The operator is implied by the credential; it is never in the path. Only a SHA-256 hash of an API key is stored server-side.

In: header

Path Parameters

id*string

UUIDv7 identifier of the resource.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/unit-types/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "object": "unit_type",    "site_id": "72771e6a-6f5e-4de4-a5b9-1266c4197811",    "name": "string",    "code": "string",    "category": "string",    "size_label": "string",    "area_sq_ft": 0,    "width_cm": 0,    "depth_cm": 0,    "height_cm": 0,    "description": "string",    "list_price_minor": 0,    "currency": "str",    "vat_treatment": "standard_20",    "storefront_status": "bookable",    "is_active": true,    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  }}
{  "error": {    "code": "unauthorized",    "message": "Missing or invalid credential."  }}
{  "error": {    "code": "insufficient_scope",    "message": "The credential lacks a scope required by this endpoint."  }}
{  "error": {    "code": "not_found",    "message": "Resource not found."  }}
{  "error": {    "code": "validation_error",    "message": "string",    "details": [      {        "field": "string",        "issue": "string"      }    ]  }}