Skip to main content
GET
https://app.pixy.art
/
api
/
v1
/
templates
cURL
curl --request GET \
  --url https://app.pixy.art/api/v1/templates \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "cmmtpl123",
      "name": "Sporty Flash Sale Social Media Post",
      "thumbnail": "https://assets.example.com/templates/flash-sale.png",
      "pagesCount": 1,
      "options": {
        "width": 1080,
        "height": 1080
      }
    }
  ],
  "total": 125,
  "page": 0,
  "perPage": 24,
  "query": "social"
}

Authorizations

​
Authorization
string
header
required

Organization API key passed as a bearer token.

Query Parameters

​
query
string

Search public templates by name.

​
page
integer
default:0

Zero-based page index.

Required range: x >= 0
​
perPage
integer
default:24

Number of templates to return per page.

Required range: 1 <= x <= 100
​
promoted
boolean
default:true

Filter by promoted templates. Defaults to true.

Response

Successfully returned public templates.

​
data
object[]
required
​
total
integer
required

Total matching templates.

​
page
integer
required

Zero-based page index.

​
perPage
integer
required

Page size used for the response.

​
query
string
required

Normalized search query.