Skip to main content
GET
https://app.pixy.art
/
api
/
v1
/
designs
cURL
curl --request GET \
  --url https://app.pixy.art/api/v1/designs \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "des_123",
      "name": "Summer campaign",
      "thumbnail": "https://assets.example.com/designs/summer.png",
      "createdAt": "2026-05-11T10:00:00.000Z",
      "updatedAt": "2026-05-11T10:05:00.000Z",
      "userId": "user_123",
      "size": {
        "width": 1080,
        "height": 1080
      }
    }
  ],
  "total": 3,
  "page": 0,
  "perPage": 24,
  "userId": "user_123",
  "search": ""
}

Documentation Index

Fetch the complete documentation index at: https://docs.pixy.art/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Organization API key passed as a bearer token.

Query Parameters

​
userId
string

Optional embedder-provided user identifier to filter designs created or opened with the same Embed userId.

Maximum string length: 128
​
search
string

Search designs by name.

​
page
integer
default:0

Zero-based page index.

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

Number of designs to return per page.

Required range: 1 <= x <= 100

Response

Successfully returned designs.

​
data
object[]
required
​
total
integer
required

Total matching designs.

​
page
integer
required

Zero-based page index.

​
perPage
integer
required

Page size used for the response.

​
userId
string | null
required

Embedder-provided user id filter, when supplied.

​
search
string
required

Normalized search text.