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

# Retrieve a card design

> Returns one card design, whether `ACTIVE` or `INACTIVE`.

With a partner-scoped API key and no `x-imprint-merchant-key` header, you can
retrieve designs configured for your partner and for any of your products. With
a merchant key, or a product-scoped API key, you can retrieve only that
product's designs. A design you cannot retrieve returns `404`.




## OpenAPI

````yaml /api-reference/openapi.yaml get /v2/card_designs/{card_design_id}
openapi: 3.1.0
info:
  title: Public Imprint API
  version: '2.0'
servers:
  - url: https://dev.sbx.imprint.co
    description: Imprint public api sandbox
security:
  - basicAuth: []
  - bearerAuth: []
paths:
  /v2/card_designs/{card_design_id}:
    get:
      tags:
        - Card Designs
      summary: Retrieve a card design
      description: >
        Returns one card design, whether `ACTIVE` or `INACTIVE`.


        With a partner-scoped API key and no `x-imprint-merchant-key` header,
        you can

        retrieve designs configured for your partner and for any of your
        products. With

        a merchant key, or a product-scoped API key, you can retrieve only that

        product's designs. A design you cannot retrieve returns `404`.
      operationId: getCardDesign
      parameters:
        - name: card_design_id
          in: path
          required: true
          description: The card design to retrieve
          schema:
            $ref: '#/components/schemas/CardDesignID'
      responses:
        '200':
          description: The card design
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CardDesign'
        '404':
          description: Card design not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CardDesignNotFoundError'
components:
  schemas:
    CardDesignID:
      type: string
      description: Imprint ID for the graphic design printed on the card
      example: 3b9c1f3e-52a0-44c1-b131-a7ab0099a214
    CardDesign:
      type: object
      required:
        - id
        - name
        - access_min_rank
        - type
        - status
      properties:
        id:
          $ref: '#/components/schemas/CardDesignID'
        name:
          type: string
          description: Human-readable name of the card design
          example: Midnight Black
        access_min_rank:
          type: integer
          format: int64
          description: >
            Minimum loyalty tier rank a customer must hold to select this
            design. `0`

            means available to everyone. A design with a rank above the
            customer's own

            tier is returned but cannot be selected by them.
          example: 0
        loyalty_tier_name:
          type: string
          description: >
            Name of the loyalty tier corresponding to `access_min_rank`.
            Currently always

            omitted; use `access_min_rank` to determine gating.
          example: GOLD
        categories:
          type: object
          additionalProperties:
            type: string
          description: Partner-defined key/value labels for grouping designs
        image_orientation:
          $ref: '#/components/schemas/CardDesignOrientation'
        type:
          $ref: '#/components/schemas/CardDesignType'
        status:
          $ref: '#/components/schemas/CardDesignStatus'
        light_asset_url_path:
          type: string
          description: >
            Absolute URL of the card design artwork for light mode. Artwork is
            served

            from `https://assets.imprint.co` or `https://app.imprint.co`
            depending on

            where it was uploaded.
          example: >-
            https://assets.imprint.co/brand-assets/card-designs/light/midnight-black.svg
        dark_asset_url_path:
          type: string
          description: >
            Absolute URL of the card design artwork for dark mode. Artwork is
            served

            from `https://assets.imprint.co` or `https://app.imprint.co`
            depending on

            where it was uploaded.
          example: >-
            https://assets.imprint.co/brand-assets/card-designs/dark/midnight-black.svg
        virtual_digital_card_art_id:
          type: string
          description: Processor-side art identifier for the virtual card
        physical_digital_card_art_id:
          type: string
          description: Processor-side art identifier for the physical card
    CardDesignNotFoundError:
      type: object
      required:
        - type
        - message
      properties:
        type:
          type: string
          description: The category of error being returned
          example: CARD_DESIGN_NOT_FOUND_ERROR
        message:
          type: string
          description: A message describing the cause of the error.
          example: card design not found
    CardDesignOrientation:
      type: string
      description: Orientation of the card design artwork
      enum:
        - UNSPECIFIED
        - VERTICAL
        - HORIZONTAL
      example: VERTICAL
    CardDesignType:
      type: string
      description: >
        Whether this is the product's default design or one of its selectable
        alternates.
      enum:
        - UNSPECIFIED
        - DEFAULT
        - REGULAR
      example: REGULAR
    CardDesignStatus:
      type: string
      description: |
        Availability of the design. Only `ACTIVE` designs can be selected.
      enum:
        - UNSPECIFIED
        - ACTIVE
        - INACTIVE
        - DELETED
      example: ACTIVE
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: >-
        Basic HTTP authentication. Allowed headers-- Authorization: Basic
        <base64(api_key_id:api_key_secret)>
    bearerAuth:
      bearerFormat: auth-scheme
      description: >-
        Bearer HTTP authentication. Allowed headers-- Authorization: Bearer
        <api_key>
      scheme: bearer
      type: http

````

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