Get card design

Returns details for a specific card design including image URLs at multiple sizes.

GET /api/3/card_designs/{id}

Authentication

This endpoint requires authentication:

OAuth 2.0 Recommended

Use an OAuth 2.0 access token in the Authorization header. This is the recommended authentication method for all integrations. OAuth provides automatic token expiration, granular permission scopes, detailed usage tracking, and per-integration revocation. Learn how to obtain an access token.

Header Format:

Authorization: Bearer YOUR_ACCESS_TOKEN

Required Scopes:

account.card_design.readonly

Parameters

Path Parameters

id integer
Required

Card Design ID

Responses

200

Card design retrieved successfully

Response Fields

id integer required

Unique identifier for the card design

eg. 42
name string required

Name of the card design

eg. Standard Blue Card
notes string | null

Free-text notes about the card design

eg. Used for full-time employees
image_front object | null

Front image URLs at multiple sizes, or null if no image is set

Show child attributes
original string

Original uploaded image URL

medium string

Medium size (600x378) image URL

small string

Small size (300x189) image URL

thumb string

Thumbnail size (150x94) image URL

image_back object | null

Back image URLs at multiple sizes, or null if no image is set

Show child attributes
original string

Original uploaded image URL

medium string

Medium size (600x378) image URL

small string

Small size (300x189) image URL

thumb string

Thumbnail size (100x94) image URL

created_at string

Timestamp of creation

updated_at string

Timestamp of last update

401

Unauthorized - Invalid or missing authentication

Response Fields

error string
eg. unauthorized
error_description string
eg. The access token is invalid
403

Forbidden - User does not have permission

Response Fields

error string
eg. forbidden
error_description string
eg. You are not authorized to access this resource
404

Not Found - Resource does not exist or is not an admission request event

Response Fields

error string
eg. not_found
error_description string
eg. The requested resource was not found
500

Internal Server Error

Response Fields

error string
eg. internal_server_error
error_description string
eg. An unexpected error occurred

Request

curl -X GET \
  "https://api.doorflow.com/api/3/card_designs/{id}" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Responses

Card design retrieved successfully

{
  "id": 42,
  "name": "Standard Blue Card",
  "notes": "Used for full-time employees",
  "image_front": {
    "original": "string",
    "medium": "string",
    "small": "string",
    "thumb": "string"
  },
  "image_back": {
    "original": "string",
    "medium": "string",
    "small": "string",
    "thumb": "string"
  },
  "created_at": "string",
  "updated_at": "string"
}