marketplace

GET /v1/marketplace/listings/{listing_id}

One of this account's Zinn®s, with the schema it is authored against.

All marketplace endpoints

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

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

NameTypeRequiredWhat it is
listing_id (path)stringYes

Response

NameTypeRequiredWhat it is
idstringYes
vendor_idstringYes
marketplace_idstringYes
marketplace_keystringYes
category_idstringNo
listing_type_idstringYes
listing_type_keystringYes
schema_versionintegerYesThe version this listing's values were authored against. Stamped once, never moved — a later schema must not reinterpret an older listing.
titlestringYes
slugstringYesPermanent once live. It is the public URL.
summarystringYes
field_valuesobjectYes"`{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 ta…
field_schemaMarketplaceFieldDefinition[]NoPresent on the detail read; the schema THIS listing is authored against.
stateMarketplaceListingStateYes⛔ `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_minorintegerYes
price_max_minorintegerYes
currencystringYes
published_atstringNo
packagesMarketplacePackage[]Yes

Errors this endpoint can return

401 · 404