---
title: "Shows a design"
method: GET
path: "/api/v1/designs/{id}"
tags: ["designs"]
---

# Shows a design

`GET /api/v1/designs/{id}`

## Request

- Base URL: `https://demo.invoiceninja.com`
- URL: `https://demo.invoiceninja.com/api/v1/designs/{id}`
- Auth: none declared. Required headers: `X-API-TOKEN`, `X-Requested-With`
- TypeScript: <https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/docs/api/v1/designs/:id/get.ts> (a function with typed inputs; its response is checked against the schema)

Displays a design by id

## Path parameters

- `id` string, string, required

## Query parameters

- `include` string

## Headers

- `X-API-TOKEN` string, required
- `X-Requested-With` string, required

## Response `200`

Returns the expense object

- Design
  - `id` string: The design hashed id
  - `name` string: The design name
  - `design` string: The design HTML
  - `is_custom` boolean: Flag to determine if the design is a custom user design
  - `is_active` boolean: Flag to determine if the design is available for use
  - `is_deleted` boolean: Flag to determine if the design is deleted
  - `created_at` number: Timestamp
  - `updated_at` number: Timestamp
  - `deleted_at` number: Timestamp

## Other responses

- `401`: Authentication error
- `403`: Authorization error
- `422`: Validation error
- `default`: Unexpected Error

## Changes

- **2026-04-20** `69a36036d334`: 1 info
  - the response optional property `id` became read-only for the status `200`
- **2024-06-06** `8e82a2bd77e0`: 2 breaking, 11 info
  - the response's body type changed from no type to `object` for status `200`
  - the response's body type changed from no type to `object` for status `default`
  - added the optional property `code` to the response with the `default` status
  - added the optional property `created_at` to the response with the `200` status
  - …9 more
- **2024-06-05** `e61df65649e2`: 1 breaking, 2 warning
  - the response's body type changed from `object` to no type for status `default`
  - removed the optional property `code` from the response with the `default` status
  - removed the optional property `message` from the response with the `default` status
- **2024-06-05** `4ca478d85068`: 1 breaking, 9 warning
  - the response's body type changed from `object` to no type for status `200`
  - removed the optional property `created_at` from the response with the `200` status
  - removed the optional property `deleted_at` from the response with the `200` status
  - removed the optional property `design` from the response with the `200` status
  - …6 more
- …earlier changes not shown

[Operation history](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/changes/api/v1/designs/:id/get.md)

---

[API](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference.md) - [All operations](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/revisions/bcda1f823746?raw)