marketplace
GET /v1/marketplace/listings/{listing_id}
One of this account's Zinn®s, with the schema it is authored against.
Authentication
Send an API key as a bearer token. This endpoint checks no specific permission, so any key for your organisation can call it.
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/listings/{listing_id} \
-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
field_schema is the version stamped on THIS listing, not the type's current head — so a form built from it edits the listing as it actually is.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
listing_id (path) | string | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
vendor_id | string | Yes | — |
marketplace_id | string | Yes | — |
marketplace_key | string | Yes | — |
category_id | string | No | — |
listing_type_id | string | Yes | — |
listing_type_key | string | Yes | — |
schema_version | integer | Yes | The version this listing's values were authored against. Stamped once, never moved — a later schema must not reinterpret an older listing. |
title | string | Yes | — |
slug | string | Yes | Permanent once live. It is the public URL. |
summary | string | Yes | — |
field_values | object | Yes | "{key: {v, ver}}" — uniform two keys, ver: null for a seller-declared value, so no consumer branches on key presence. ⛔ A domain value is NOT here — it is in the reveal… |
field_schema | MarketplaceFieldDefinition[] | No | Present on the detail read; the schema THIS listing is authored against. |
state | MarketplaceListingState | Yes | ⛔ archived, never deleted. A listing that sold has public URLs, backlinks and an order behind it, and a 404 costs rankings that do not come back. |
price_minor | integer | Yes | — |
price_max_minor | integer | Yes | — |
currency | string | Yes | — |
published_at | string | No | — |
packages | MarketplacePackage[] | Yes | — |
inclusion_items | MarketplaceInclusionItem[] | No | What comes with the asset, as the seller composed it. Rows carrying zinn_asset were added by the platform because the listing sells a site or domain hosted with us (docs/714… |
inclusion_revision | integer | No | How many times the seller has revised the list since publishing. |
description | string | No | s1006 — the long description, PLAIN TEXT: paragraphs separated by a blank line, list lines starting - . Never HTML; it is rendered as text. |
faqs | MarketplaceFaq[] | No | The listing's FAQ, shown on the page and as FAQPage structured data. |
zinn_site_id | string | No | The site on our hosting this listing sells, set by listListingFromSite only. When the listing sells, the site moves into the buyer's account automatically. |
zinn_domain_id | string | No | The domain in our account this listing sells, set by listListingFromDomain only. |
Errors this endpoint can return
401 · 404