{
  "name": "Gymshark Products API",
  "description": "Products from Gymshark UK collection pages, with product name, image and product link.",
  "api_id": "generated_21ac18f87ad65090f8480c76",
  "slug": "gymshark-products-api",
  "source": {
    "name": "Gymshark UK",
    "domain": "uk.gymshark.com",
    "url": "https://uk.gymshark.com/"
  },
  "category": "commerce",
  "countries": [
    "GB"
  ],
  "languages": [
    "en"
  ],
  "record_types": [],
  "tags": [],
  "limitations": [
    "Prices, colours and ratings are not returned.",
    "The collection input offers four collections."
  ],
  "updated": "2026-10-26",
  "note": "Sample records are saved samples, not a live run. CleanedWeb is not affiliated with the source.",
  "endpoints": [
    {
      "endpoint_id": "generated_21ac18f87ad65090f8480c76_search",
      "name": "Extract records",
      "description": "Return records within the accepted scope.",
      "definition_version": "6eca2b7936228943b822a185df1e7e14a7c5280e92a1361b900a37251bcf7e17",
      "method": "POST",
      "path": "/v1/catalog/public/apis/generated_21ac18f87ad65090f8480c76/endpoints/generated_21ac18f87ad65090f8480c76_search/run",
      "url": "https://broker.cleanedweb.com/v1/catalog/public/apis/generated_21ac18f87ad65090f8480c76/endpoints/generated_21ac18f87ad65090f8480c76_search/run",
      "authentication": {
        "type": "bearer",
        "scheme": "Authorization: Bearer <API key>",
        "scope": "run",
        "note": "Reading this file and the live catalog needs no credential. A run needs a CleanedWeb account and uses the credits of its workspace.",
        "docs": "https://cleanedweb.com/docs/run-catalog-api/"
      },
      "required_headers": [
        {
          "name": "Authorization",
          "value": "Bearer YOUR_API_KEY",
          "description": "An API key with the run scope."
        },
        {
          "name": "Idempotency-Key",
          "value": "UNIQUE_REQUEST_ID",
          "description": "Required. Save it before you send; reuse it only to retry the same request and to read the result. 1-200 characters: letters, numbers, . _ : -"
        },
        {
          "name": "Content-Type",
          "value": "application/json",
          "description": "The body is JSON."
        }
      ],
      "request_body": {
        "input": "An object that follows input_schema.",
        "max_items": "Optional. Stop after this many records.",
        "timeout_seconds": "Optional, 60-86400, default 10800.",
        "wait_seconds": "Optional, 0-86400, default 90. How long the request waits before answering 202."
      },
      "input_schema": {
        "type": "object",
        "properties": {
          "collection": {
            "type": "string",
            "enum": [
              "New Product Drops",
              "All Accessories",
              "All Socks",
              "All Equipment"
            ],
            "description": "Choose an independently verified source collection/filter route. Omit it to read the pasted collection itself."
          }
        },
        "required": [],
        "additionalProperties": false
      },
      "output_schema": {
        "type": "object",
        "additionalProperties": true,
        "required": [
          "title",
          "url"
        ],
        "properties": {
          "image_url": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "url": {
            "type": "string",
            "format": "uri"
          }
        }
      },
      "output_schema_note": "Some fields the source returns are not published here (identifiers, personal details and page-building noise). A record can carry fields this schema does not list, so additionalProperties is true. Do not reject a record for an extra field. The live contract, linked as live_contract, lists every field the saved definition declares.",
      "examples": [
        {
          "kind": "saved_validation_records",
          "saved_at": "2026-10-26T13:53:02.729Z",
          "live_verified": false,
          "request": {
            "input": {}
          },
          "records_shown": 2,
          "records_saved": 2,
          "records": [
            {
              "image_url": "https://cdn.shopify.com/s/files/1/0098/8822/files/Seamless_Running_Waistbelt_GS_Black_I2C9H_BB2J_3_3840x.jpg?v=1790783631",
              "title": "Seamless Running Waistbelt",
              "url": "https://uk.gymshark.com/products/gymshark-seamless-running-waistbelt-equipment-black-aw26"
            },
            {
              "image_url": "https://cdn.shopify.com/s/files/1/0098/8822/files/images-MiniLiftingBeltKeyringGSBlackI2C5M_BB2J_3862_V1_3840x.jpg?v=1775483915",
              "title": "Lifting Belt Keyring",
              "url": "https://uk.gymshark.com/products/gymshark-lifting-belt-keyring-misc-black-ss26"
            }
          ]
        }
      ],
      "request_example": {
        "body": {
          "input": {
            "collection": "New Product Drops"
          },
          "max_items": 25
        },
        "curl": "curl -X POST https://broker.cleanedweb.com/v1/catalog/public/apis/generated_21ac18f87ad65090f8480c76/endpoints/generated_21ac18f87ad65090f8480c76_search/run \\\n  -H \"Authorization: Bearer YOUR_API_KEY\" \\\n  -H \"Idempotency-Key: UNIQUE_REQUEST_ID\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n  \"input\": {\n    \"collection\": \"New Product Drops\"\n  },\n  \"max_items\": 25\n}'"
      },
      "result": {
        "method": "GET",
        "url": "https://broker.cleanedweb.com/v1/catalog/public/apis/generated_21ac18f87ad65090f8480c76/endpoints/generated_21ac18f87ad65090f8480c76_search/result",
        "note": "A run that does not end within wait_seconds answers 202. Read the result with the same API key and the same Idempotency-Key."
      },
      "links": {
        "page": "https://cleanedweb.com/catalog/gymshark-products-api/",
        "markdown": "https://cleanedweb.com/catalog/gymshark-products-api/index.md",
        "live_contract": "https://app.cleanedweb.com/api/catalog/apis/generated_21ac18f87ad65090f8480c76/endpoints/generated_21ac18f87ad65090f8480c76_search/contract",
        "run_docs": "https://cleanedweb.com/docs/run-catalog-api/"
      }
    }
  ],
  "links": {
    "page": "https://cleanedweb.com/catalog/gymshark-products-api/",
    "markdown": "https://cleanedweb.com/catalog/gymshark-products-api/index.md",
    "contract": "https://cleanedweb.com/catalog/gymshark-products-api/contract.json",
    "catalog": "https://cleanedweb.com/catalog/",
    "index": "https://cleanedweb.com/catalog/index.json",
    "openapi": "https://cleanedweb.com/catalog/openapi.json"
  }
}