Reference

Get Artwork

Retrieve detailed information about a specific artwork including preview images, media specifications, and metadata by its unique ID.

List Artwork

Retrieve and browse all available artwork in your organization, with options to filter, search, and paginate through your designs. Use this to discover what creative assets are available for your projects and campaigns.

Retrieve Account Balance

Check your available account and gift credit balances to understand your current spending capacity and plan your card orders accordingly.

List Credit History

Retrieve your account's complete transaction history showing all credits and debits with timestamps and descriptions to understand where your balance changes are coming from. Use this to track spending patterns, verify charges, and monitor refunds or promotional credits.

List Gift Credit History

Retrieve a complete history of gift credit transactions including additions, deductions, and balance changes for your organization. Use this to track promotional credit usage and maintain accurate records of credit movements.

Create Contact List

Organize and manage your contacts by creating a new contact list with customizable fields, allowing you to segment your audience for targeted communication campaigns.

List Contact Lists

Retrieve all active contact lists in your organization to view their custom fields and automation rules. Use this to get an overview of your contact management structure and find specific lists for targeting.

List Doodles

Retrieve all available doodle designs from your Cardly account to see what visual styles you can use when creating cards. This helps you discover and select the right design for your messaging needs.

List Fonts

Retrieve all available fonts for personalizing handwriting and text in Cardly cards, including font names, categories, and variant options. Use this to explore design choices and ensure your card designs support the personalization features you need.

List Writing Styles

Retrieve all available writing styles for personalizing handwritten content in cards and communications. This helps you choose the right style to match your brand voice or personal preferences.

Create Invitation

Send an invitation to a new user via email to grant them access to your organization's portal. This streamlines onboarding by allowing you to quickly add team members, contractors, or clients without manual account creation.

Delete Invitation

Remove a pending invitation so it can no longer be accepted, immediately invalidating the invite link or code. Use this when you need to cancel an invite you previously sent.

Delete Invitation by Email

Revoke a pending invitation by email address, immediately preventing the recipient from being able to accept access. Useful when you need to undo an invitation due to errors, personnel changes, or security concerns.

List Invitations

Retrieve all active invitations sent to users in your organization, allowing you to see who's been invited and their current status.

List Media

Retrieve all available media sizes and formats for your product artwork before creating designs. This helps you understand exactly what dimensions and specifications your cards support.

List Orders

Retrieve all orders placed with your organization, including customer information, pricing, items ordered, and shipping details. Use pagination controls to manage large order lists efficiently.

Retrieve Order

Fetch complete details about a specific order including customer information, purchased items, pricing, and delivery status. This helps you access critical order information whenever you need to check status, fulfill requests, or follow up with customers.

Generate Preview

Generate a preview of your card design with watermark to see how it will look before placing a full order, allowing you to verify the layout and content are correct.

Echo Request

Verifies API connectivity and validates your authentication setup by echoing back all request details without making any changes to your account data.

List Templates

Retrieve all your saved greeting card templates from Cardly so you can browse and select the right design for your next card send.

Delete User

Permanently removes a user from your organization and revokes their access to your portal. This action is immediate and irreversible, making it essential for offboarding employees or contractors.

Delete User by Email

Removes a user from your organization's portal by their email address, immediately revoking their access. Useful for offboarding team members or terminating access when needed.

List Users

Retrieve all users associated with your Cardly account with pagination support. Useful for viewing your team members and managing who has access to your account.

Retrieve User

Fetch detailed profile information for a specific user account, including their name, email, status, and permissions. Use this to verify user details or check account status before taking actions on their behalf.

Create Webhook

Set up automated notifications so your app receives real-time alerts whenever specific Cardly events occur, enabling you to respond instantly to important card activities.

Delete Webhook

Stop receiving notifications from Cardly by removing a webhook that's no longer needed, instantly halting all event subscriptions tied to that endpoint.

Get Webhook

Retrieve the configuration details of a webhook, including its target URL, subscribed events, status, and other metadata to verify or audit your webhook setup.

List Webhooks

Retrieve all webhooks set up for your organization to see their status, target URLs, and which events they're listening to. This helps you monitor webhook health and manage your integrations effectively.

Update Webhook

Modify a webhook's configuration such as its target URL and the events it monitors, allowing you to redirect notifications or change which activities trigger updates without recreating the webhook.