Ketch

Ketch Preferences API

Generate QR codes for the preference center.

Documentation GitHub OpenAPI

Operations 1

GET /qr/{organizationCode}/{propertyCode}/preferences.png Get a QR code image for the preference center #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/ketch-io/openapi/ketch-io-preferences-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/ketch-io:ketch-io-preferences-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Ketch Web Preferences API
  description: 'REST endpoints that power Ketch consent collection, consent retrieval and

    update, data subject rights, and preference center QR codes. Endpoint paths

    and behavior are derived from the open source Ketch Web API SDK at

    https://github.com/ketch-sdk/ketch-web-api which is the canonical client for

    the Ketch global edge endpoints served from https://global.ketchcdn.com/web/v3.'
  version: 3.0.0
  contact:
    name: Ketch
    url: https://docs.ketch.com/
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
- url: https://global.ketchcdn.com/web/v3
  description: Ketch global edge production API.
tags:
- name: Preferences
  description: Generate QR codes for the preference center.
paths:
  /qr/{organizationCode}/{propertyCode}/preferences.png:
    parameters:
    - $ref: '#/components/parameters/OrganizationCode'
    - $ref: '#/components/parameters/PropertyCode'
    get:
      tags:
      - Preferences
      summary: Get a QR code image for the preference center
      operationId: getPreferencesQr
      parameters:
      - name: env
        in: query
        required: false
        schema:
          type: string
      - name: size
        in: query
        required: false
        schema:
          type: integer
          minimum: 64
          maximum: 2048
      - name: path
        in: query
        required: false
        schema:
          type: string
      - name: bgcolor
        in: query
        required: false
        schema:
          type: string
      - name: fgcolor
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: A PNG QR code image.
          content:
            image/png:
              schema:
                type: string
                format: binary
components:
  parameters:
    OrganizationCode:
      name: organizationCode
      in: path
      required: true
      schema:
        type: string
    PropertyCode:
      name: propertyCode
      in: path
      required: true
      schema:
        type: string