--- title: Get Swatch Collection slug: api-documentation/get-swatch-collection docTags: createdAt: 2026-08-27T16:53:40.115Z --- { "id": "xEJ0auMM6o-rvA_e7XpQ4", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.upstartcommerce.com/v1/catalog/swatches/collections/{swatchCollectionId}", "servers": [ { "url": "https://api.upstartcommerce.com/v1/catalog/swatches/collections/{swatchCollectionId}" } ], "name": "Get Swatch Collection", "description": "

Returns an existing swatch collection.

\n

Authorized permissions:

\n\n

Authorized roles:

\n", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "swatchCollectionId", "type": "object", "description": "ID of the swatch collection", "customType": "SwatchCollectionId", "schema": [], "modelRef": "#/components/schemas/SwatchCollectionId" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" }, { "kind": "required", "name": "x-upstart-tenant", "type": "string", "description": "Tenant identifier associated with the site this call is for." }, { "kind": "optional", "name": "x-upstart-site", "type": "string", "description": "Unique identifier for the site." } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "NoChannelPortalAccess", "name": "NoChannelPortalAccess", "kind": "optional", "type": "http", "description": "

This authentication is required for clients to interact with any of the management APIs. Similar to \"LoggedIn\", it indicates that the user has actually logged into the system, but in this case with a management role.

", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Swatch collection", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "This defines the structure of a swatch collection summary.", "customType": "SwatchCollectionSummary", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "" }, { "name": "type", "kind": "required", "type": "object", "description": "This defines the structure of a swatch collection type summary.", "modelRef": "#/components/schemas/SwatchCollectionTypeSummary", "customType": "SwatchCollectionTypeSummary", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "", "modelRef": "#/components/schemas/SwatchCollectionTypeId", "customType": "SwatchCollectionTypeId", "schema": [] }, { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "tags", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "imageUrl", "kind": "optional", "type": "string", "description": "", "pattern": "^(http:\\/\\/www\\.|https:\\/\\/www\\.|http:\\/\\/|https:\\/\\/)?[a-z0-9]+([\\-\\.]{1}[a-z0-9]+)*\\.[a-z]{2,5}(:[0-9]{1,5})?(\\/.*)?$" }, { "name": "imageAltText", "kind": "optional", "type": "string", "description": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "" }, { "name": "tags", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "hexCode", "kind": "optional", "type": "string", "description": "", "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$" } ], "modelRef": "#/components/schemas/SwatchCollectionSummary", "isExpanded": true } ] }, { "statusCode": "401", "description": "The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "404", "description": "The requested resource was not found in the NoChannel system.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "WlKrqIXGTqB_p014EhIDZ", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.upstartcommerce.com/v1/catalog/swatches/collections/{swatchCollectionId} \\\n --header 'accept: application/json' \\\n --header 'x-upstart-tenant: string'" }, { "id": "D8QXCR6B92jPMYFQ1cSlH", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-upstart-tenant\", \"string\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/v1/catalog/swatches/collections/{swatchCollectionId}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "NEtsBY3PNhoFHHBlytjwo", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/catalog/swatches/collections/{swatchCollectionId}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-upstart-tenant\"] = \"string\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "j8zIMA-4FRm3eSY6kkfYL", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/catalog/swatches/collections/{swatchCollectionId}\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-upstart-tenant': 'string'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "WlKrqIXGTqB_p014EhIDZ" }, "results": { "languages": [ { "id": "d0VivpjUznje-5JFGN-ir", "language": "200", "code": "// Swatch collection\n{\n \"id\": \"\",\n \"type\": {\n \"id\": \"\",\n \"name\": \"\",\n \"tags\": [\n \"\"\n ]\n },\n \"name\": \"\",\n \"imageUrl\": \"\",\n \"imageAltText\": \"\",\n \"description\": \"\",\n \"tags\": [\n \"\"\n ],\n \"hexCode\": \"\"\n}" }, { "id": "ni-4z_B5jFJ6qYOl2xndt", "language": "401", "code": "// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "gOiU5DCAQ8Pax2nOqenOi", "language": "404", "code": "// The requested resource was not found in the NoChannel system.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" } ], "selectedLanguageId": "d0VivpjUznje-5JFGN-ir" } }, "children": [ { "text": "" } ] }