Templates

GET /v1/templates/

Retrieves templates data

template_id endpoint retrieves just a single template.

Template Schema

Field

Type

Description

id

uuid

Unique identifier for template object.

created_at

timestamp

When the template was created.

updated_at

timestamp

When the template was updated.

created_by_id

uuid

Which user created the template.

version

integer

The media version of the template.

orientation

string

The orientation of the template (landscape, portrait)

type

string

The type of template (i.e. "postcard-4x6")

name

string

The name of the template.

curl -X GET --header "Accept: application/json" --header "Authorization: Inkit <api-key>" "https://api.inkit.io/v1/templates/"
The above command returns JSON structured like this:

{
    "body": {
        "id": "02bc92c7fa1e6c00e7920e8321492664",
        "created_at": "2018-10-19T12:01",
        "updated_at": "2018-10-19T12:01",
        "created_by_id": "419eb138d2445c57f795b42ab11b7a2a",
        "version": 1,
        "orientation": "landscape",
        "type": "postcard-4x6",
        "name": "December Mailer"
        },
    "response": {
        "message": "",
        "status_code": 200
    }
}

Did this page help you?