List Designs

Return every design in your workspace as a flat array — each item carries the design's identity (id, name, type), its project, and a preview thumbnail. Filter by project and/or design type. The listing is deliberately shallow: it contains no formats or elements — fetch a design's full structure with Design Details, and pick the right design for a generation from its id.

GET/designsAPI Reference

Query parameters

Parameter	Type	Required	Description
project_id	string (uuid)	No	Filter designs by project UUID. List projects with GET /projects.
type	string	No	Filter by design type: "static", "animated", "printer", "printer_multipage". An unknown value is ignored — the full unfiltered list is returned, never a 400.

Pagination & ordering

There is no pagination: the full list is returned in a single response, sorted alphabetically by design name. Filter with project_id and/or type to keep responses small on large workspaces.

Visibility

The listing returns every design in your workspace, minus:

• Deleted designs — a deleted design is gone from the listing immediately.
• Designs whose project was deleted — a design is only listed while its project exists.
• Workspace templates — never listed here; they have their own listing. See Designs vs Workspace Templates.

Sample request

Replace {YOUR-API-KEY} before running.

curl -H "x-api-key: {YOUR-API-KEY}" \
  "https://api.abyssale.com/designs?type=static"

Response

Returns an array of design objects.

Field	Type	Description
id	string (uuid)	Unique identifier of the design.
name	string	Name of the design.
type	string	Design type: "static", "animated", "printer", or "printer_multipage".
created_at	integer	Unix timestamp of creation.
updated_at	integer	Unix timestamp of last update.
project_id	string (uuid)	Project the design belongs to. Always present — every design lives in a project.
project_name	string	Name of that project.
category_id	string (uuid) | null	Deprecated alias of project_id.
category_name	string | null	Deprecated alias of project_name.
preview_url	string (uri)	Design thumbnail: a static PNG rendering of the design's first format (the first one created), at that format's full dimensions. Every design type gets one — an animated design yields a still frame, printer / printer_multipage a rasterized page. The URL is always present, but the image behind it may not exist yet for a design whose preview was never generated. Per-format previews come from Design Format Details.

Response example

[
  {
    "id": "64238d01-d402-474b-8c2d-fbc957e9d290",
    "name": "Ad campaign fall 2025",
    "type": "static",
    "created_at": 1649942114,
    "updated_at": 1649942114,
    "project_id": "9d1f2b7c-5a44-4c3e-9f21-0b8e6d4a1c73",
    "project_name": "Fall campaigns",
    "category_id": "9d1f2b7c-5a44-4c3e-9f21-0b8e6d4a1c73",
    "category_name": "Fall campaigns",
    "preview_url": "https://production-banners.s3-eu-west-1.amazonaws.com/templates/e0d292f2-ec21-11e9-a539-3c408bf94155/a9b3c668-7b84-4924-adf0-815dae727d32.png"
  },
  {
    "id": "bdf9ab44-f5fd-47ad-881d-a45906901233",
    "name": "Summer video ads",
    "type": "animated",
    "created_at": 1663767647,
    "updated_at": 1663767647,
    "project_id": "2f6b8d10-7c31-4e59-b0a4-6c1e93f2d885",
    "project_name": "Summer 2025",
    "category_id": "2f6b8d10-7c31-4e59-b0a4-6c1e93f2d885",
    "category_name": "Summer 2025",
    "preview_url": "https://production-banners.s3-eu-west-1.amazonaws.com/templates/f1a302g3-dd32-22f0-b640-4d519cf05266/b0c4d779-8c95-5035-beg1-926ebf838e43.png"
  }
]

Related

• Design Details — fetch one design's formats and elements
• Projects — list the projects you can filter by
• Designs vs Workspace Templates — which listing to use
• Node.js SDK — every method, config, retries and the polling helpers