curl --request GET \
--url https://dev.sbx.imprint.co/v2/card_designs/{card_design_id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://dev.sbx.imprint.co/v2/card_designs/{card_design_id}"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://dev.sbx.imprint.co/v2/card_designs/{card_design_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://dev.sbx.imprint.co/v2/card_designs/{card_design_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://dev.sbx.imprint.co/v2/card_designs/{card_design_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://dev.sbx.imprint.co/v2/card_designs/{card_design_id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://dev.sbx.imprint.co/v2/card_designs/{card_design_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"id": "3b9c1f3e-52a0-44c1-b131-a7ab0099a214",
"name": "Midnight Black",
"access_min_rank": 0,
"type": "REGULAR",
"status": "ACTIVE",
"loyalty_tier_name": "GOLD",
"categories": {},
"image_orientation": "VERTICAL",
"light_asset_url_path": "https://assets.imprint.co/brand-assets/card-designs/light/midnight-black.svg",
"dark_asset_url_path": "https://assets.imprint.co/brand-assets/card-designs/dark/midnight-black.svg",
"virtual_digital_card_art_id": "<string>",
"physical_digital_card_art_id": "<string>"
}{
"type": "CARD_DESIGN_NOT_FOUND_ERROR",
"message": "card design not found"
}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.
curl --request GET \
--url https://dev.sbx.imprint.co/v2/card_designs/{card_design_id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://dev.sbx.imprint.co/v2/card_designs/{card_design_id}"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://dev.sbx.imprint.co/v2/card_designs/{card_design_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://dev.sbx.imprint.co/v2/card_designs/{card_design_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://dev.sbx.imprint.co/v2/card_designs/{card_design_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://dev.sbx.imprint.co/v2/card_designs/{card_design_id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://dev.sbx.imprint.co/v2/card_designs/{card_design_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"id": "3b9c1f3e-52a0-44c1-b131-a7ab0099a214",
"name": "Midnight Black",
"access_min_rank": 0,
"type": "REGULAR",
"status": "ACTIVE",
"loyalty_tier_name": "GOLD",
"categories": {},
"image_orientation": "VERTICAL",
"light_asset_url_path": "https://assets.imprint.co/brand-assets/card-designs/light/midnight-black.svg",
"dark_asset_url_path": "https://assets.imprint.co/brand-assets/card-designs/dark/midnight-black.svg",
"virtual_digital_card_art_id": "<string>",
"physical_digital_card_art_id": "<string>"
}{
"type": "CARD_DESIGN_NOT_FOUND_ERROR",
"message": "card design not found"
}Authorizations
Basic HTTP authentication. Allowed headers-- Authorization: Basic <base64(api_key_id:api_key_secret)>
Path Parameters
The card design to retrieve Imprint ID for the graphic design printed on the card
"3b9c1f3e-52a0-44c1-b131-a7ab0099a214"
Response
The card design
Imprint ID for the graphic design printed on the card
"3b9c1f3e-52a0-44c1-b131-a7ab0099a214"
Human-readable name of the card design
"Midnight Black"
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.
0
Whether this is the product's default design or one of its selectable alternates.
UNSPECIFIED, DEFAULT, REGULAR "REGULAR"
Availability of the design. Only ACTIVE designs can be selected.
UNSPECIFIED, ACTIVE, INACTIVE, DELETED "ACTIVE"
Name of the loyalty tier corresponding to access_min_rank. Currently always
omitted; use access_min_rank to determine gating.
"GOLD"
Partner-defined key/value labels for grouping designs
Show child attributes
Show child attributes
Orientation of the card design artwork
UNSPECIFIED, VERTICAL, HORIZONTAL "VERTICAL"
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.
"https://assets.imprint.co/brand-assets/card-designs/light/midnight-black.svg"
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.
"https://assets.imprint.co/brand-assets/card-designs/dark/midnight-black.svg"
Processor-side art identifier for the virtual card
Processor-side art identifier for the physical card