PSD mockups

Retrieve the layers of a PSD mockup

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.

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

Path parameters

uuidstring required

Mockup UUID

Example:123e4567-e89b-12d3-a456-426614174000

Response

Successful Response

successboolean

Always true on a successful response.

Example response

{
  "data": {
    "layers": [
      {
        "children": [
          {
            "children": [],
            "kind": "text",
            "name": "Badge text",
            "uuid": "523e4567-e89b-12d3-a456-426614174004",
            "visible": true
          },
          {
            "children": [],
            "kind": "shape",
            "name": "Badge shape",
            "uuid": "623e4567-e89b-12d3-a456-426614174005",
            "visible": true
          }
        ],
        "kind": "group",
        "name": "Sleeve badge",
        "uuid": "423e4567-e89b-12d3-a456-426614174003",
        "visible": true
      },
      {
        "children": [],
        "kind": "text",
        "name": "Name",
        "uuid": "323e4567-e89b-12d3-a456-426614174002",
        "visible": true
      },
      {
        "children": [],
        "kind": "text",
        "name": "Nickname",
        "uuid": "923e4567-e89b-12d3-a456-426614174008",
        "visible": false
      },
      {
        "children": [],
        "kind": "smart_object",
        "name": "Main Design",
        "uuid": "223e4567-e89b-12d3-a456-426614174001",
        "visible": true
      },
      {
        "children": [],
        "kind": "pixel",
        "name": "T-shirt",
        "uuid": "723e4567-e89b-12d3-a456-426614174006",
        "visible": true
      },
      {
        "children": [],
        "kind": "fill",
        "name": "Background",
        "uuid": "823e4567-e89b-12d3-a456-426614174007",
        "visible": true
      }
    ],
    "mockup_uuid": "123e4567-e89b-12d3-a456-426614174000"
  },
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.