VOvoucherifyio
Card Definitions

Get Card Definition

<Warning>

<Badge color="yellow">BETA endpoint</Badge>

This is a work-in-progress documentation of a BETA endpoint. The parameters, fields, request and response bodies, and other data may subject to change. If you want to share feedback or improvements, contact Voucherify support or your Technical Account Manager.

</Warning>

Returns a single card definition by its ID.

get/v2/loyalties/card-definitions/{cardDefinitionId}

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v2/loyalties/card-definitions/{cardDefinitionId}
  • Auth
    none required

Path parameters

idstring required

Unique card definition ID. Pattern: ^lcdef_[a-f0-9]+$.

Response

The card definition.

idstring required

Unique card definition ID.

namestring required

Card definition name.

type'INDIVIDUAL' required

Card definition type.

status'DRAFT' | 'ACTIVE' | 'DELETED' required

Current card definition status.

metadataobject required

Arbitrary key-value metadata. Empty object when not set.

created_atstring date-time required

Creation timestamp (ISO 8601).

updated_atstring date-time required

Last update timestamp (ISO 8601). Null when the card definition has never been updated.

objectstring required

Object type marker. Always card_definition.

Changes

No recorded changes to this operation across all 1 revision of this API.