Skip to main content
GET
Search tenant fields

Authorizations

Authorization
string
header
required

MeshQu API key passed as a bearer token: Authorization: Bearer mqu_…. Mint one in the console (Settings → API keys).

X-MeshQu-Tenant-Id
string
header
required

Tenant UUID for multi-tenant isolation. Required on all authenticated routes — validated before authentication (middleware/tenant.ts), so a missing or non-UUID header returns 400 (MISSING_TENANT_ID / INVALID_TENANT_ID) before the API key is checked.

Query Parameters

prefix
string

Prefix to filter field names. Returns a RANKED page (busiest first), so a matching key can be absent from it — use field_name to ask about one exact key.

limit
integer

Page size for the ranked prefix/list read. Defaults to 20. Accepted and IGNORED alongside field_name, which returns one item or none.

Required range: 1 <= x <= 100
field_name
string

The EXACT canonical key, e.g. vendor. Returns items with that one field, or an EMPTY items when the tenant has no such key — never a 404, because "no declaration" is an answer. Independent of usage rank and of limit (accepted and ignored here); mutually exclusive with prefix (400 FIELD_QUERY_AMBIGUOUS).

Required string length: 1 - 128

Response

Default Response

items
object[]
required