Search eCards (Enterprise) #
Search and page through the eCard designs in your account — handy for building your own gallery, picker, or admin tooling.
Status: Enterprise-only, and actively evolving. Unlike the public Bearer endpoints, this one is a dashboard (session-authenticated) endpoint today — it authenticates with your logged-in dashboard session (
cfid/cftoken), not solely the API key. If you need eCard listing in a pure server-to-server (Bearer) flow, useGET /pub/ecard-actions/get-ecards(lists the eCards in a widget). Contact support if you need broader programmatic search access.
Endpoint #
GET https://app.ecardwidget.com/v2/api/ecard/search
Parameters #
| Name | Type | Required | Description |
|---|---|---|---|
page |
integer | no | Page number (default 1) |
perPage |
integer | no | Results per page (default 6) |
keyword |
string | no | Free-text search over eCard name/details |
widgetID |
integer | no | Limit to a single widget (0 = all) |
ecardIDs |
string | no | Comma-separated list of eCard IDs (numeric or vanity) to fetch |
filterByDate |
string | no | Date-range filter (e.g. any-time, last-week) |
sortBy |
string | no | Sort order (e.g. custom-order) |
Authentication: your dashboard session (cfid / cftoken). (An Authorization: Bearer header may
also be supplied, but the session is what scopes results to your account.)
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 #
The standard envelope, with a data array of eCard objects and a meta object (alerts + account
limits / pagination):
{
"success": true,
"data": [ { "id": 14744, "name": "Happy Birthday", "vanity_id": "e4xgrzltk", "...": "..." } ],
"meta": { "page": 1, "per_page": 6, "page_count": 3, "total_count": 14 },
"messages": []
}
Status codes #
| Code | Meaning |
|---|---|
200 |
Success |
400 |
Malformed/invalid request |
401 |
Invalid session credentials |