brands

Get a brand

Return a single brand by its short-id, or a 404 if no brand has that id.

Supports sparse fieldsets via fields[brands]. A retired id (one merged into another brand) forwards to the surviving brand at 200 with an added canonical_id field, so a stored id never dead-ends after a merge.

get/v1/brands/{id}

Request

Base URL: https://api.noms.sh
URL: https://api.noms.sh/v1/brands/{id}
Auth: API key in header X-API-Key

Path parameters

idstring required

Brand short-id (12-char base62).

Example:XoluRyOx9o3C

Query parameters

fields[brands]string

Sparse fieldset. A comma-separated subset of brands fields to return (e.g. id,name). Omit to return all fields.

Headers

If-None-Matchstring

An ETag from a previous response for this URL. If it still matches, the API answers 304 Not Modified with no body; otherwise you get the full 200. Either way the request is metered.

Response

A single brand. fields[brands] may trim the keys present in data. If the requested id was retired by a merge, the canonical brand is returned with an extra canonical_id field naming its live id — update any stored reference to it.

Example response

{
  "data": {
    "id": "XoluRyOx9o3C",
    "name": "Blue Diamond"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.