Skip to main content

Catalog Vendors Domain

The Catalog Vendors domain provides a single endpoint for listing application vendors. Vendors are shared reference data -- they are not scoped to a single client.

A vendor represents the company or organization that publishes one or more catalog apps (e.g. Google LLC, Microsoft Corporation). Vendors are linked to catalog apps via catalog_applications.vendor_id.

Vendors are embedded inside CatalogApp responses as CatalogVendor. Use the list endpoint below when you need the full set of vendors for filter dropdowns or admin UIs.

For embedding and endpoint design decisions, see the Design Guidelines.

Endpoints

EndpointMethodDescription
List Catalog VendorsGETPaginated list of all vendors. Use for filter dropdowns and admin views.

Why there is no Get Vendor endpoint

The CatalogVendor object is small and complete -- id, name, and url. The list endpoint already returns the full object for every vendor. A detail endpoint would return zero additional data, so it is omitted.

Data Transfer Objects (DTOs)

CatalogVendor

Full vendor representation returned by the list endpoint. This is the same shape as the CatalogVendor embedded inside CatalogApp -- there are no additional fields that only a vendor-primary endpoint would expose.

{
"id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"name": "Google LLC",
"url": "https://about.google"
}
FieldTypeNullableDescription
idstring (uuid)NoStable unique identifier for the vendor
namestringNoVendor display name
urlstringYesVendor website URL

DB source: catalog_vendors.id, catalog_vendors.name, catalog_vendors.url

Omitted internal fields: created_by, updated_by, created_at, updated_at

Used in: List Catalog Vendors