AI sign designs
List AI designs
Lists the store's AI designs, newest first, with cursor pagination. An AI design is one upload to the AI sign designer: from a shopper in the customer customiser, from a quote file converted in the merchant admin or with this API, from a merchant admin upload, or from an AI sign design job of this API.
Overview
Requires ai_sign_designs:read. Follow links.next while
pagination.has_more is true, sending each cursor back unchanged with
the same filters and timezone. An erased design is not listed.
The shopper's name, email and contact details are never returned. A
quote holds the contact details the shopper sent, under quotes:read.
filter[status] keeps one outcome. filter[origin] keeps one origin.
filter[customiser_id] keeps the designs made in one customiser.
filter[created_from] and filter[created_to] are inclusive calendar
days, counted in timezone (UTC when it is absent).
Authorisation
Bearer token required. Include it in the Authorization header.
Required scope: ai_sign_designs:read
Query parameters
Page size from 1 to 100. Defaults to 20.
Example: 20
The opaque next_cursor from a previous page.
Example: eyJ2IjoxfQ
Only return designs with this status. One of processing, delivered, refused, failed.
Example: delivered
Only return designs from this origin. One of customer_customiser, quote, merchant_admin, api.
Example: customer_customiser
Only return designs made in this customiser.
Example: 42
Earliest day to include, inclusive, as YYYY-MM-DD in `timezone`.
Example: 2026-10-01
Latest day to include, inclusive, as YYYY-MM-DD in `timezone`. Must not be earlier than filter[created_from].
Example: 2026-10-31
The IANA timezone the created days are counted in. Defaults to `UTC`.
Example: Australia/Sydney
curl https://web.signcustomiser.com/api/v3/ai-designs?limit=20&cursor=eyJ2IjoxfQ&filter%5Bstatus%5D=delivered&filter%5Borigin%5D=customer_customiser&filter%5Bcustomiser_id%5D=42&filter%5Bcreated_from%5D=2026-10-01&filter%5Bcreated_to%5D=2026-10-31&timezone=Australia%2FSydney \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_API_TOKEN'{
"data": [
{
"object": "ai_design",
"id": 51234,
"origin": "quote",
"status": "delivered",
"product_family": "neon",
"customiser_id": 42,
"files": [
{
"kind": "svg",
"purpose": "design",
"media_type": "image/svg+xml",
"access": "private",
"url": "https://web.signcustomiser.com/api/v3/ai-designs/51234/files/svg",
"download_url": null
},
{
"kind": "eps",
"purpose": "manufacturing_export",
"media_type": "application/postscript",
"access": "private",
"url": "https://web.signcustomiser.com/api/v3/ai-designs/51234/files/eps",
"download_url": null
},
{
"kind": "illustrator_pdf",
"purpose": "manufacturing_export",
"media_type": "application/pdf",
"access": "private",
"url": "https://web.signcustomiser.com/api/v3/ai-designs/51234/files/illustrator_pdf",
"download_url": null
},
{
"kind": "raster_preview",
"purpose": "preview",
"media_type": "image/png",
"access": "private",
"url": "https://web.signcustomiser.com/api/v3/ai-designs/51234/files/raster_preview",
"download_url": null
},
{
"kind": "source",
"purpose": "source",
"media_type": "image/png",
"access": "private",
"url": "https://web.signcustomiser.com/api/v3/ai-designs/51234/files/source",
"download_url": null
},
{
"kind": "source_preview",
"purpose": "source",
"media_type": "image/png",
"access": "private",
"url": "https://web.signcustomiser.com/api/v3/ai-designs/51234/files/source_preview",
"download_url": null
}
],
"product_ids": [
90211
],
"order_ids": [
123
],
"quote_id": 8123,
"quote_file": {
"field_id": "field_artwork",
"file_index": 0
},
"ai_sign_design_job_id": null,
"feedback_rating": "thumbs_up",
"created_at": "2026-10-20T09:32:00Z"
},
{
"object": "ai_design",
"id": 51240,
"origin": "api",
"status": "delivered",
"product_family": "channel_letter",
"customiser_id": null,
"files": [
{
"kind": "svg",
"purpose": "design",
"media_type": "image/svg+xml",
"access": "private",
"url": "https://web.signcustomiser.com/api/v3/ai-designs/51240/files/svg",
"download_url": "https://web.signcustomiser.com/ai-design-files/K8RlIzJLh3ZJchirFwxb8umEpjUyUoZfi51Cg1FCTW4vD55TtY4vrq9Iud04WavV"
},
{
"kind": "raster_preview",
"purpose": "preview",
"media_type": "image/png",
"access": "private",
"url": "https://web.signcustomiser.com/api/v3/ai-designs/51240/files/raster_preview",
"download_url": "https://web.signcustomiser.com/ai-design-files/yv4v2Oz5HRxkr4OfsvPu6P9EiNdfQtdV5K6vB8pzgvTf6RpTn2fehWtZlXkvmWTB"
},
{
"kind": "source",
"purpose": "source",
"media_type": "image/png",
"access": "private",
"url": "https://web.signcustomiser.com/api/v3/ai-designs/51240/files/source",
"download_url": "https://web.signcustomiser.com/ai-design-files/Wa60lEfaTgSKNoXIh0q8dn1ijiMklLiKtPvs51weaITQyDoUpCMhfTPQrvNWrQLV"
},
{
"kind": "source_preview",
"purpose": "source",
"media_type": "image/png",
"access": "private",
"url": "https://web.signcustomiser.com/api/v3/ai-designs/51240/files/source_preview",
"download_url": null
}
],
"product_ids": [],
"order_ids": [],
"quote_id": null,
"quote_file": null,
"ai_sign_design_job_id": "aijob_4k8m2p6r9t1v3x5z7b0d2f4h6j",
"feedback_rating": null,
"created_at": "2026-10-19T11:05:00Z"
},
{
"object": "ai_design",
"id": 40017,
"origin": "customer_customiser",
"status": "delivered",
"product_family": null,
"customiser_id": 42,
"files": [
{
"kind": "svg",
"purpose": "design",
"media_type": "image/svg+xml",
"access": "public",
"url": "https://web.signcustomiser.com/api/v3/ai-designs/40017/files/svg",
"download_url": "https://assets.signcustomiser.com/svgs/4f1c2a9e.svg"
},
{
"kind": "source",
"purpose": "source",
"media_type": "image/jpeg",
"access": "public",
"url": "https://web.signcustomiser.com/api/v3/ai-designs/40017/files/source",
"download_url": "https://assets.signcustomiser.com/raw/4f1c2a9e.jpg"
}
],
"product_ids": [],
"order_ids": [],
"quote_id": null,
"quote_file": null,
"ai_sign_design_job_id": null,
"feedback_rating": "thumbs_down",
"created_at": "2026-03-02T07:45:00Z"
}
],
"pagination": {
"has_more": false,
"next_cursor": null
},
"links": {
"self": "https://web.signcustomiser.com/api/v3/ai-designs",
"documentation": "https://www.signcustomiser.com/help/api/",
"next": null
},
"meta": {
"api_version": "v3",
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}
}{
"type": "https://www.signcustomiser.com/help/api/problems/missing_api_key",
"title": "Missing API key",
"status": 401,
"code": "missing_api_key",
"detail": "Provide a store API key as a bearer token.",
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}{
"type": "https://www.signcustomiser.com/help/api/problems/insufficient_scope",
"title": "Insufficient scope",
"status": 403,
"code": "insufficient_scope",
"detail": "This operation requires the ai_sign_designs:read scope.",
"required_scopes": [
"ai_sign_designs:read"
],
"granted_scopes": [
"customisers:read"
],
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}{
"type": "https://www.signcustomiser.com/help/api/problems/invalid_parameter",
"title": "Invalid query parameter",
"status": 422,
"code": "invalid_parameter",
"detail": "The filter[status] value is not a supported AI design status.",
"errors": [
{
"parameter": "filter[status]",
"code": "unsupported_value",
"detail": "The filter[status] value is not a supported AI design status.",
"allowed_values": [
"processing",
"delivered",
"refused",
"failed"
]
}
],
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}{
"type": "https://www.signcustomiser.com/help/api/problems/rate_limited",
"title": "Too many requests",
"status": 429,
"code": "rate_limited",
"detail": "You have exceeded the request limit for this API key.",
"retry_after": 60,
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}