Search eCards API Endpoint

Note: The API is limited to Enterprise Customers only. The feature is new and is under active development. We welcome any questions or feedback you may have. Feel free to reach out to us at [email protected].

View more API Endpoints

`GET /v2/api/ecard/search`

Summary

This endpoint searches for eCards based on the provided parameters and returns a paginated list.

Request Parameters

Name	Type	Description	Required
`page`	integer	The page number of the results to return.	No
`perPage`	integer	The number of results to return per page.	No
`filterByDate`	string	A filter for the date range (e.g., `any-time`, `last-week`).	No
`sortBy`	string	Sort order of the results (e.g., `custom-order`).	No
`widgetID`	integer	The Widget ID to filter eCards by.	No
`cftoken`	string	ColdFusion token for session authentication.	Yes
`cfid`	string	ColdFusion ID for session authentication.	Yes

Authorization

Include the following header in your request: 'Authorization: Bearer YOUR_API_KEY'

To get your API Key, login and go to your Account Details, you will find it there. Make sure you don't ever expose this key because it allows full control over the account and access to all data.

Request Example

curl 'https://app.ecardwidget.com/v2/api/ecard/search?page=1&perPage=6&filterByDate=any-time&sortBy=custom-order&widgetID=0' \ 
-H 'accept: application/json' \ 
-H 'Authorization: Bearer YOUR_API_KEY'

Response

Returns a JSON object containing a success flag, a data array of eCard objects, and a meta object containing any alerts and account limits.

Ecard Object

Field	Type	Description
thumb_image	string	Thumbnail image URL of the ecard.
customFieldsConfig	Config	Custom fields configuration object.
usesCustomFieldCanvas	boolean	Whether the ecard uses custom field canvas.
hasCustomFieldItems	boolean	Whether the ecard has custom field items.
filesize	string	File size of the ecard.
ecardLink	string	URL link to the ecard.
ecard_mode	string	Mode of the ecard (e.g., "pre-checkout", "post-payment").
envelope_theme	string	Theme of the envelope.
envelope_bg_image_url	string	Background image URL of the envelope.
envelope_color_settings	EnvelopeColorSettings	Envelope color settings object.
pixie_config_path	string	Path to the image editor configuration.
predefinedSchedule	string	Predefined schedule settings.
publishOn	string	Date the ecard will be published.
og_description	string	OpenGraph description for sharing.
personalMessageBox	number	Personal message box configurations.
filename	string	Filename of the ecard.
cover_image	string	Cover image of the ecard.
cardconfig	string	Card configuration details.
disabled	boolean	Whether the ecard is disabled.
canSchedule	boolean	Whether the ecard can be scheduled.
url_redirect_after_send	string	URL to redirect to after the ecard is sent.
videoLink	string	Video link related to the ecard.
details	string	Additional details of the ecard.
sortOrder	number	Sort order for display.
createdAt	string	Date the ecard was created.
name	string	Name of the ecard.
predefinedScheduleOn	boolean	Whether predefined schedule is on.
self_hosted_url	string	Self-hosted URL of the ecard.
header	string	Header text for the ecard.
widgetid	number	ID of the widget that the ecard belongs to.
ecardbrandid	number	ID of the ecard brand.
legacy	boolean	Whether the ecard is a legacy item.
predefinedScheduleForced	boolean	Whether predefined schedule is forced.
ecardLinkAltText	string	Alt text for the ecard link.
userid	number	ID of the user who owns the ecard.
siteid	number	ID of the site the ecard belongs to.
id	number	Unique ID of the ecard.
widget	Widget	Widget configuration object.
updatedat	string	Date the ecard was last updated.
og_title	string	OpenGraph title for sharing.
expireOn	string (optional)	Expiry date of the ecard.
price	number (optional)	Price of the ecard.
emailSubject	string	Email subject for the ecard.
ownerid	number	ID of the owner of the ecard.
globalized	boolean	Whether the ecard is globalized.
is_selected	boolean (optional)	Whether the ecard is selected.

Response Example

{ 
  "success": true, 
  "data": [ { "id": 1, ... }, { "id": 2, ... }, ... ], 
  "meta": { 
    "alerts": [...], ...
  } 
}

Status Codes

200 OK: The request was successful.
400 Bad Request: The request was malformed or invalid.
401 Unauthorized: Invalid session credentials.

Note: For an exhaustive list of eCard object fields, refer to the Data section.

Using the Public Page Feature in eCard Widget

List Sent Email Stats Endpoint

Send eCards via Email Endpoint

Trigger Custom Actions when eCards are Shared

Advanced eCard Envelope Styling: A Complete Guide to Re-Theming with CSS