Templates


Retrieve the template data of your project including IDs, template titles and layer information via the API.

List all templates of a project

Get a list of all your project's templates and their layer information. The API returns 20 items per page.

Endpoint

Method URI
GET https://api.placid.app/api/rest/templates

Response

{
    "data": [
        {
            "uuid": "template_uuid",
            "title": "Template Title",
            "layers": [
                {
                    "name": "Text Layer",
                    "type": "text"
                },
                {
                    "name": "Picture Layer",
                    "type": "picture"
                },
                {
                    "name": "Rectangle Layer",
                    "type": "rectangle"
                },
                {
                  "name": "Browser Layer",
                  "type": "browserframe"
                }
            ]
        }
    ],
    "links": {
        "first": null,
        "last": null,
        "prev": "...", // - link to previous page
        "next": "..." // - link to next page
    },
    "meta": {
        "path": "http://placid-spark.valet/api/rest/templates",
        "per_page": 20
    }
}
Field Values
data Array of templates
template.uuid The template uuid
template.title The template title
template.layers All dynamic layers of the template; To be filled with all applicable layer properties when generating images
links.prev Link to prev cursored page
links.next Link to next cursored page

Retrieve a template

Retrieve a specific template and its layer information by adding a UUID to your call.

Endpoint

Method URI
GET https://api.placid.app/api/rest/templates/{uuid}

Response

{
    "uuid": "template_uuid",
    "title": "Template Title",
    "layers": [
        {
            "name": "Text Layer",
            "type": "text"
        },
        {
            "name": "Picture Layer",
            "type": "picture"
        },
        {
            "name": "Rectangle Layer",
            "type": "rectangle"
        },
        {
            "name": "Browser Layer",
            "type": "browserframe"
        }
    ]
}
Field Values
template.uuid The template uuid
template.title The template title
template.layers All dynamic layers of the template; To be filled with all applicable layer properties when generating images