Depict Listing (v3) API
The Listing (v3) API from Depict — 5 operation(s) for listing (v3).
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/depict:depict-listing-v3-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Depict Listing (v3) API
version: '1.0'
tags:
- name: Listing (v3)
paths:
/v3/listings:
get:
tags:
- Listing (v3)
summary: Get Listings
operationId: Get_Listings_v3_listings_get
parameters:
- name: merchant
in: query
required: true
schema:
type: string
title: Merchant
- name: market
in: query
required: true
schema:
type: string
title: Market
- name: locale
in: query
required: true
schema:
type: string
title: Locale
- name: types
in: query
required: false
schema:
type: array
items:
$ref: '#/components/schemas/CollectionKind'
default: []
title: Types
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/V3ListListingsResponseItem'
title: Response Get Listings V3 Listings Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v3/listings/external_id/{external_id}:
get:
tags:
- Listing (v3)
summary: Get Listing Via External Id
operationId: Get_Listing_via_External_ID_v3_listings_external_id__external_id__get
parameters:
- name: external_id
in: path
required: true
schema:
anyOf:
- type: string
- type: 'null'
title: External Id
- name: merchant
in: query
required: true
schema:
type: string
title: Merchant
- name: market
in: query
required: true
schema:
type: string
title: Market
- name: locale
in: query
required: true
schema:
type: string
title: Locale
- name: listing_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Listing Id
- name: session_id
in: query
required: false
schema:
type: string
default: ''
title: Session Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/V3GetCollectionListingResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v3/listings/{listing_id}:
get:
tags:
- Listing (v3)
summary: Get Listing
operationId: Get_Listing_v3_listings__listing_id__get
parameters:
- name: listing_id
in: path
required: true
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Listing Id
- name: merchant
in: query
required: true
schema:
type: string
title: Merchant
- name: market
in: query
required: true
schema:
type: string
title: Market
- name: locale
in: query
required: true
schema:
type: string
title: Locale
- name: session_id
in: query
required: false
schema:
type: string
default: ''
title: Session Id
- name: external_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: External Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/V3GetCollectionListingResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
ImageContent:
properties:
text:
anyOf:
- type: string
maxLength: 140
- type: 'null'
title: Text
cta:
anyOf:
- type: string
maxLength: 60
- type: 'null'
title: Cta
text_position:
$ref: '#/components/schemas/ContentTextPosition'
default: bottom-center
type:
type: string
const: image
title: Type
default: image
url:
type: string
title: Url
link:
anyOf:
- type: string
- type: 'null'
title: Link
type: object
required:
- url
- link
title: ImageContent
VideoContent:
properties:
text:
anyOf:
- type: string
maxLength: 140
- type: 'null'
title: Text
cta:
anyOf:
- type: string
maxLength: 60
- type: 'null'
title: Cta
text_position:
$ref: '#/components/schemas/ContentTextPosition'
default: bottom-center
type:
type: string
const: video
title: Type
default: video
url:
type: string
title: Url
link:
anyOf:
- type: string
- type: 'null'
title: Link
type: object
required:
- url
- link
title: VideoContent
ContentPosition:
type: string
enum:
- left
- right
- center
title: ContentPosition
ProductListing:
properties:
listing_id:
type: string
format: uuid
title: Listing Id
description: Depict ID of the listing.
external_id:
anyOf:
- type: string
- type: 'null'
title: External Id
description: ID of the listing in the merchant PIM, CMS or similar.
listing_type:
$ref: '#/components/schemas/CollectionKind'
show_in_breadcrumbs:
type: boolean
title: Show In Breadcrumbs
description: Show or hide this listing in navigation breadcrumbs.
show_in_quicklinks:
type: boolean
title: Show In Quicklinks
description: Show or hide this listing in quicklinks.
image_urls:
items:
type: string
type: array
title: Image Urls
description: List of image URLs for the listing.
title:
type: string
title: Title
slug:
anyOf:
- type: string
- type: 'null'
title: Slug
page_url:
anyOf:
- type: string
- type: 'null'
title: Page Url
description: The listing's own page URL from the merchant's store attributes, when ingested. Absent otherwise; a storefront that composes URLs from `ancestors` + `slug` keeps doing so.
type: object
required:
- listing_id
- listing_type
- show_in_breadcrumbs
- show_in_quicklinks
- image_urls
- title
title: ProductListing
CollectionKind:
type: string
enum:
- long_tail_collection
- campaign
- category
- smart_pick
- style
- brand
- look
title: CollectionKind
ContentBlock:
properties:
span_columns:
type: integer
title: Span Columns
span_rows:
type: integer
title: Span Rows
position:
$ref: '#/components/schemas/ContentPosition'
row:
type: integer
title: Row
content:
anyOf:
- $ref: '#/components/schemas/ImageContent'
- $ref: '#/components/schemas/VideoContent'
title: Content
type: object
required:
- span_columns
- span_rows
- position
- row
- content
title: ContentBlock
ContentTextPosition:
type: string
enum:
- top-left
- top-center
- top-right
- middle-left
- middle-center
- middle-right
- bottom-left
- bottom-center
- bottom-right
title: ContentTextPosition
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
type: object
required:
- loc
- msg
- type
title: ValidationError
V3GetCollectionListingResult:
properties:
listing_id:
type: string
format: uuid
title: Listing Id
description: Depict ID of the listing.
external_id:
anyOf:
- type: string
- type: 'null'
title: External Id
description: ID of the listing in the merchant PIM, CMS or similar.
listing_type:
$ref: '#/components/schemas/CollectionKind'
show_in_breadcrumbs:
type: boolean
title: Show In Breadcrumbs
description: Show or hide this listing in navigation breadcrumbs.
show_in_quicklinks:
type: boolean
title: Show In Quicklinks
description: Show or hide this listing in quicklinks.
image_urls:
items:
type: string
type: array
title: Image Urls
description: List of image URLs for the listing.
title:
type: string
title: Title
slug:
anyOf:
- type: string
- type: 'null'
title: Slug
page_url:
anyOf:
- type: string
- type: 'null'
title: Page Url
description: The listing's own page URL from the merchant's store attributes, when ingested. Absent otherwise; a storefront that composes URLs from `ancestors` + `slug` keeps doing so.
ancestors:
items:
$ref: '#/components/schemas/ProductListing'
type: array
title: Ancestors
description: Ordered list of ancestors of the listing, useful for navigation breadcrumbs.
siblings:
items:
$ref: '#/components/schemas/ProductListing'
type: array
title: Siblings
description: Siblings of the listing, i.e. listings that share the same parent, INCLUDING the listing itself.
children:
items:
$ref: '#/components/schemas/ProductListing'
type: array
title: Children
description: Children of the listing, i.e. listings that have the listing as their parent.
content_blocks:
items:
$ref: '#/components/schemas/ContentBlock'
type: array
title: Content Blocks
description: List of content blocks to be displayed on the listing page.
type: object
required:
- listing_id
- listing_type
- show_in_breadcrumbs
- show_in_quicklinks
- image_urls
- title
- ancestors
- siblings
- children
- content_blocks
title: V3GetCollectionListingResult
V3ListListingsResponseItem:
properties:
listing_id:
type: string
format: uuid
title: Listing Id
description: Depict ID of the listing.
external_id:
anyOf:
- type: string
- type: 'null'
title: External Id
description: ID of the listing in the merchant PIM, CMS or similar.
listing_type:
$ref: '#/components/schemas/CollectionKind'
show_in_breadcrumbs:
type: boolean
title: Show In Breadcrumbs
description: Show or hide this listing in navigation breadcrumbs.
show_in_quicklinks:
type: boolean
title: Show In Quicklinks
description: Show or hide this listing in quicklinks.
image_urls:
items:
type: string
type: array
title: Image Urls
description: List of image URLs for the listing.
title:
type: string
title: Title
slug:
anyOf:
- type: string
- type: 'null'
title: Slug
page_url:
anyOf:
- type: string
- type: 'null'
title: Page Url
description: The listing's own page URL from the merchant's store attributes, when ingested. Absent otherwise; a storefront that composes URLs from `ancestors` + `slug` keeps doing so.
children:
items:
$ref: '#/components/schemas/V3ListListingsResponseItem'
type: array
title: Children
type: object
required:
- listing_id
- listing_type
- show_in_breadcrumbs
- show_in_quicklinks
- image_urls
- title
- children
title: V3ListListingsResponseItem
x-provenance:
method: harvested
publisher: Depict
source: https://api.depict.ai/openapi.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)