marketplace
GET /v1/marketplace/listing-types/{key}/schema
The public field schema for a kind of Zinn®.
Authentication
This endpoint takes no API key. Anything else it needs, such as a signed request, is described above.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/marketplace/listing-types/{key}/schema \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
⭐ This is what makes "add a field, no deploy" true on the client side: the vendor form and the public renderer are generated from this response rather than compiled against a copy, so a bundle pinned to an older build still renders the fields the running engine has. ⛔ Public fields only. A private field's label is harmless on its own, but its presence tells a scraper exactly which listings to ask about, and this endpoint is anonymous.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
key (path) | string | Yes | — |
locale (query) | string | No | Render every operator-authored string — field labels, help text, enum option labels — in this locale, falling back to the source language per string. ⛔ A query parameter rather… |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
key | string | Yes | — |
name | string | Yes | — |
schema_version | integer | Yes | — |
field_schema | MarketplaceFieldDefinition[] | Yes | — |
Errors this endpoint can return
404