---
title: "Retrieve the layers of a PSD mockup"
method: GET
path: "/api/v1/psd-mockups/{uuid}/layers"
tags: ["PSD mockups"]
---

# Retrieve the layers of a PSD mockup

`GET /api/v1/psd-mockups/{uuid}/layers`

## Request

- Base URL: `https://api.sudomock.com`
- URL: `https://api.sudomock.com/api/v1/psd-mockups/{uuid}/layers`
- Auth: API key in header `x-api-key`

Read every layer of a mockup, nested the way Photoshop's Layers panel shows them and listed front-most first. A smart object whose contents hold layers you can fill lists those layers as its children. Send a layer's uuid in hidden_layers on POST /api/v1/renders to leave that layer out of a render.

## Path parameters

- `uuid` string, required: Mockup UUID

## Response `200`

Successful Response

- MockupLayersResponse: Every layer of a PSD mockup, nested the way Photoshop's Layers panel shows them.
  - `success` boolean: Always true on a successful response.
  - `data` MockupLayersData, required: The layers of one PSD mockup.
    - `mockup_uuid` string, required: The mockup these layers belong to.
    - `layers` MockupLayer[], required: Top-level layers, front-most first, in the order Photoshop's Layers panel lists them. A group carries its own layers in children, and so does a smart object whose contents hold layers you can fill.
      - `uuid` string, required: The layer's UUID. Send it in hidden_layers to leave the layer out of a render. A smart object, text layer or group listed in the mockup's smart_objects, text_layers or group_layers carries the same UUID here.
      - `name` string, required: The layer's name in the PSD.
      - `kind` string, required: What the layer is: artboard, group, smart_object, text, pixel, shape, fill or adjustment.
      - `visible` boolean, required: Whether the layer is shown in the source file. False as well when a group or artboard around it is hidden.
      - `children` MockupLayer[]: The layers inside this layer, front-most first: a group's own layers, or the layers of a smart object's contents when those contents hold layers you can fill. Copies of one smart object share their contents, which are listed under one copy. An artboard's own layers are listed right before the artboard at the top level, not here. Empty for every other layer.

---

[API](https://skmtc.dev/sudomock/apis/sudomock-api.md) · [All operations](https://skmtc.dev/sudomock/apis/sudomock-api/llms.txt) · [OpenAPI document](https://skmtc.dev/sudomock/apis/sudomock-api/revisions/c1cc24006c60?raw)
