---
title: "Get Listing Via External Id"
method: GET
path: "/v3/listings/external_id/{external_id}"
tags: ["Listing (v3)"]
---

# Get Listing Via External Id

`GET /v3/listings/external_id/{external_id}`

## Path parameters

- `external_id` string, nullable, required

## Query parameters

- `merchant` string, required
- `market` string, required
- `locale` string, required
- `listing_id` string, uuid, nullable
- `session_id` string

## Response `200`

Successful Response

- V3GetCollectionListingResult
  - `listing_id` string, uuid, required — Depict ID of the listing.
  - `external_id` string, nullable — ID of the listing in the merchant PIM, CMS or similar.
  - `listing_type` 'long_tail_collection' | 'campaign' | 'category' | 'smart_pick' | 'style' | 'brand' | 'look', required
  - `show_in_breadcrumbs` boolean, required — Show or hide this listing in navigation breadcrumbs.
  - `show_in_quicklinks` boolean, required — Show or hide this listing in quicklinks.
  - `image_urls` string[], required — List of image URLs for the listing.
  - `title` string, required
  - `slug` string, nullable
  - `ancestors` ProductListing[], required — Ordered list of ancestors of the listing, useful for navigation breadcrumbs.
    - `listing_id` string, uuid, required — Depict ID of the listing.
    - `external_id` string, nullable — ID of the listing in the merchant PIM, CMS or similar.
    - `listing_type` 'long_tail_collection' | 'campaign' | 'category' | 'smart_pick' | 'style' | 'brand' | 'look', required
    - `show_in_breadcrumbs` boolean, required — Show or hide this listing in navigation breadcrumbs.
    - `show_in_quicklinks` boolean, required — Show or hide this listing in quicklinks.
    - `image_urls` string[], required — List of image URLs for the listing.
    - `title` string, required
    - `slug` string, nullable
  - `siblings` ProductListing[], required — Siblings of the listing, i.e. listings that share the same parent, INCLUDING the listing itself.
    - `listing_id` string, uuid, required — Depict ID of the listing.
    - `external_id` string, nullable — ID of the listing in the merchant PIM, CMS or similar.
    - `listing_type` 'long_tail_collection' | 'campaign' | 'category' | 'smart_pick' | 'style' | 'brand' | 'look', required
    - `show_in_breadcrumbs` boolean, required — Show or hide this listing in navigation breadcrumbs.
    - `show_in_quicklinks` boolean, required — Show or hide this listing in quicklinks.
    - `image_urls` string[], required — List of image URLs for the listing.
    - `title` string, required
    - `slug` string, nullable
  - `children` ProductListing[], required — Children of the listing, i.e. listings that have the listing as their parent.
    - `listing_id` string, uuid, required — Depict ID of the listing.
    - `external_id` string, nullable — ID of the listing in the merchant PIM, CMS or similar.
    - `listing_type` 'long_tail_collection' | 'campaign' | 'category' | 'smart_pick' | 'style' | 'brand' | 'look', required
    - `show_in_breadcrumbs` boolean, required — Show or hide this listing in navigation breadcrumbs.
    - `show_in_quicklinks` boolean, required — Show or hide this listing in quicklinks.
    - `image_urls` string[], required — List of image URLs for the listing.
    - `title` string, required
    - `slug` string, nullable
  - `content_blocks` ContentBlock[], required — List of content blocks to be displayed on the listing page.
    - `span_columns` integer, required
    - `span_rows` integer, required
    - `position` 'left' | 'right' | 'center', required
    - `row` integer, required
    - `content` union, required
      - ImageContent
        - `text` string, nullable
        - `text_position` 'top-left' | 'top-center' | 'top-right' | 'middle-left' | 'middle-center' | 'middle-right' | 'bottom-left' | 'bottom-center' | 'bottom-right'
        - `type` 'image'
        - `url` string, required
        - `link` string, nullable, required
      - VideoContent
        - `text` string, nullable
        - `text_position` 'top-left' | 'top-center' | 'top-right' | 'middle-left' | 'middle-center' | 'middle-right' | 'bottom-left' | 'bottom-center' | 'bottom-right'
        - `type` 'video'
        - `url` string, required
        - `link` string, nullable, required

## Other responses

- `422` — Validation Error

## Changes

- **2026-08-27** `eff645035c5f` — 4 info
  - added the optional property `content_blocks/items/content/anyOf[subschema #1: ImageContent]/text` to the response with the `200` status
  - added the optional property `content_blocks/items/content/anyOf[subschema #1: ImageContent]/text_position` to the response with the `200` status
  - added the optional property `content_blocks/items/content/anyOf[subschema #2: VideoContent]/text` to the response with the `200` status
  - added the optional property `content_blocks/items/content/anyOf[subschema #2: VideoContent]/text_position` to the response with the `200` status

[Change history](https://skmtc.dev/depict/apis/depict-api/changes/v3/listings/external_id/:external_id/get.md)

---

[API](https://skmtc.dev/depict/apis/depict-api.md) · [All operations](https://skmtc.dev/depict/apis/depict-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/depict/depict-api/revisions/d7d78e2cc0be/schema)