GET /v1/vendor-catalog

Read the shared vendor catalog (find). Requires a signed-in connection. Pages contain at most 100 rows and 1 MiB. Oversized expanded reads can be read as individual documents through /raw. Shares a per-principal budget of 120 reads per minute with MCP.

All operations · Reusable schemas

Complete operation contract

{
  "operationId": "vendor_catalog.find",
  "description": "Read the shared vendor catalog (find). Requires a signed-in connection. Pages contain at most 100 rows and 1 MiB. Oversized expanded reads can be read as individual documents through /raw. Shares a per-principal budget of 120 reads per minute with MCP.",
  "parameters": [
    {
      "name": "q",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "domain",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "sender",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "descriptor",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "shelf",
      "in": "query",
      "required": false,
      "schema": {
        "enum": [
          "vendors",
          "standard-agreements",
          "patterns"
        ]
      }
    },
    {
      "name": "after",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Catalog read",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "matches": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/EntryMatch"
                }
              },
              "cursor": {
                "type": [
                  "string",
                  "null"
                ]
              }
            },
            "required": [
              "matches",
              "cursor"
            ]
          }
        }
      }
    },
    "400": {
      "description": "Invalid input or cursor",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    },
    "401": {
      "description": "Sign-in required",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    },
    "404": {
      "description": "Unknown vendor, plan or document",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    },
    "429": {
      "description": "Catalog read budget exhausted; Retry-After: 60",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    },
    "503": {
      "description": "Catalog unavailable; Retry-After applies",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}