Card Templates

Get background image

Returns the background image for the specified side. Redirects to the image URL.

GET /api/3/card_templates/{id}/background_image/{side}

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:

private.account.card_template.readonly

Parameters

Path Parameters

id integer
Required

Card template ID

side string
Required

Which side of the card

Responses

302

Redirect

Redirect to image URL

404

Template or image not found

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

Request

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

Responses

Redirect to image URL

{}