> ## Documentation Index
> Fetch the complete documentation index at: https://docs.snappy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Swag Designs: Your Company's Logo Designs

> List, retrieve and rename your company's swag designs, and browse the products created from each design. Schema, business rules and V3 design endpoints.

A **Design** is a logo-based design that belongs to your company (e.g. "Acme Summit 2026 - Primary"). Designs are applied to swag [Base Products](https://docs.snappy.com/modules/api/v3/swag/overview.md) to create branded items. Each design has a name and the logo that is printed on its items (the `imprint`).

With the Designs API you can:

* List your company's designs and search them by name
* Get a single design
* Rename a design
* Browse the products created from a design

> [!TIP]
>
> New to swag? Start with the [Swag overview](https://docs.snappy.com/modules/api/v3/swag/overview.md) for Base Products and Base Variants.

***

## The Design Object

| Field | Type | Description |
| :- | :- | :- |
| `id` | string | Design UUID (e.g. `3f1c2a9e-8b7d-4c1e-9f0a-2b3c4d5e6f70`) |
| `name` | string | Display name of the Design. Unique within the company. |
| `imprint` | string or null | URL of the logo printed on the design items, or `null` when the design has no logo. |

```json theme={null}
{
  "id": "3f1c2a9e-8b7d-4c1e-9f0a-2b3c4d5e6f70",
  "name": "Acme Summit 2026 - Primary",
  "imprint": "https://image.snappy.com/9f4e84f84d94"
}
```

***

## Design Products

A design's products are the branded items created from that design. They use the same Product shape as `GET /v3/products`, so you can reuse the same parsing for both. See [Products](https://docs.snappy.com/modules/api/v3/products/overview.md) for the full object.

Prices and availability depend on the `location` query parameter, which defaults to `US`.

***

## Key Concepts & Business Rules

#### Account scoping

Every Design request requires the `Snappy-Account-Id` header. Designs are scoped to that account. An unknown account returns `404`.

#### Design availability

Only designs that are ready are returned. A design that is still being generated is not listed, and responds with `404` on get, rename and its product endpoints.

#### Sorting and filtering

Designs and design products are always returned newest first. `sort` is not supported.

The design list supports one filter:

* `filter[search]` - case-insensitive search on the design name (1-100 characters)

Design products don't support filters. Unknown query parameters return `400` on every Design endpoint.

#### Pagination

The list endpoints use **page-number pagination** (`page[number]`, `page[size]`), and return `links.first`, `links.next` and `links.prev`:

| Endpoint | Max page size | Default page size |
| :- | :- | :- |
| List designs | 100 | 100 |
| List design products | 100 | 100 |

See [Request & Response Standards](https://docs.snappy.com/pages/request-response-standards.md) for the full V3 pagination contract.

#### Renaming a design

Only `name` can be changed. It is trimmed and must be 1-100 characters. Any other body field (for example `imprint`) returns `400`. Design names are unique within the company: renaming a design to a name another design already uses returns `409`.

#### Products of another design

Getting a product through a design only works for that design's own products. A product that doesn't exist, or that belongs to another design, returns `404` with the same error code.

#### Permissions

| Action | Required scope |
| :- | :- |
| List designs, get a design, list and get design products | `swag:designs:read` |
| Rename a design | `swag:designs:update` |

***

## How to Work with Designs

**List designs**

```text theme={null} theme={null}
GET /v3/swag/designs?filter[search]=Summit
```

Returns a paginated list of the company's Designs, newest first.

**Get a single design**

```text theme={null} theme={null}
GET /v3/swag/designs/{designId}
```

Returns one Design. This endpoint does not accept query parameters.

**Rename a design**

```text theme={null} theme={null}
PATCH /v3/swag/designs/{designId}
```

```json theme={null}
{ "name": "Acme Summit 2026 - Primary" }
```

Returns the updated Design. Returns `404` if the design does not exist, and `409` if another design in the company already uses the name.

**List the products of a design**

```text theme={null} theme={null}
GET /v3/swag/designs/{designId}/products?location=US
```

Returns a paginated list of the design's products, newest first. Supports the same `include` and `fields` options as `GET /v3/products`.

**Get one product of a design**

```text theme={null} theme={null}
GET /v3/swag/designs/{designId}/products/{productId}?location=US
```

Returns one product of the design, in the same shape as `GET /v3/products/{productId}`.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.