Get all Card(s)
Query a single digital card or display all cards linked to your user account.
If you want to query all cards from a space, go to the 'Business Manager / Space' tab.
All Cards connect with User Account
GET /v1/cards
Headers
| Name | Type | Description |
|---|---|---|
Accept* | String | application/json |
Content-Type* | String | application/json |
{
"data": [
{
"uuid": "enuh1....",
"avatar": {
"uuid": "NwAdb.....",
"src": "https://LINK",
"src_large": "https://LINK",
"mim_type": "image/jpeg",
"extension": "jpg",
"size": "4.27 KB"
},
"username": "pablo-martinez",
"display_name": "Pablo Martinez",
"redirection": null,
"is_business": false,
"space": null,
"connected_cards": 1,
"connected_products": [
{
"uuid": "jEByqXXXXXX",
"type": "card",
"serial_key": "XXXXXX",
"active": true,
"revoked": false,
"activated_at": "2020-02-02 11:15:31",
"is_locked": false,
"default_card": "enuh1mF01XXXXXXX",
"connected_cards": [
{....}
]
}
],
"asset": {
"image": {
"uuid": "T9X77miXXXXX",
"src": "https://cdn.becard.me/LINK",
"mim_type": "image/png"
}
}
}
},
]
}
Get a single digital card
GET /v1/cards/{CARD_ID}
{
"data": {
"uuid": "ZHJ8l7wXXXXXX",
"public": true,
"username": "jon-doe-XXXX",
"firstName": "Jon",
"lastName": "Doe",
"prefix": null,
"suffix": null,
"display_name": "Jon Doe",
"organisation": null,
"position": "CTO",
"department": "DevOps",
"focus": "contact",
"template": "recent",
"color": null,
"visible": 0,
"is_premium": false,
"is_business": true,
"space": {
"user_role": "admin",
"card_role": "admin",
"name": "Demo Company ltd.",
"uuid": "FdGkHPXXXXXX",
"username": "demo-company-ltd-XXXX",
"assets": {
"cover": null,
"icon": "https://cdn.becard.me/default/space_v1.jpg",
"logo": "https://cdn.becard.me/live/logo/space-1673949154711-XXXXX.jpg",
"header": null,
"favicon": null,
"background": null
}
},
"redirection": null,
"video_frame": null,
"short_description": null,
"assets": {
"avatar": {
"uuid": null,
"src": "https://cdn.becard.me/default/card_v1.jpg"
},
"header": null,
"logo": null
},
"contacts": [
{
"uuid": "9F5EXXXX",
"type": "phone",
"category": "default",
"pos": null,
"name": null,
"value": "+4316580000",
"prefix": null,
"default": 1
},
{
"uuid": "7BY97z4XXXXX",
"type": "phone",
"category": "default",
"pos": null,
"name": null,
"value": "4316580000",
"prefix": null,
"default": 1
}
],
"addresses": null,
"social_media": [],
"settings": {
"protection": {
"enable_pin": false
},
"layout": {
"save_avatar": true,
"show_avatar": true,
"show_logo": true,
"show_icon": false,
"show_header": true,
"show_organisation": true,
"show_address": true,
"show_vcf_link": true,
"show_login_button": true,
"show_becard_logo": true,
"enable_backgrounds": false,
"enable_blur": false,
"enable_dark_mode": false,
"enable_favicons": false
},
"services": {
"enable_contact_book": false,
"enable_multi_language": false,
"enable_social_media": true,
"enable_wallets": true,
"enable_pushNotifications": false,
"enable_pushNotifications_fields": {
"pushNotification_id": null
},
"enable_newsletter": false,
"enable_newsletter_fields": {
"email": true,
"name": true,
"phone": false
},
"enable_qrCode": true,
"enable_affiliate": false,
"enable_affiliate_fields": {
"code": null,
"link": null
}
},
"permissions": {
"allow_change_header": true,
"allow_change_logo": true,
"allow_change_avatar": true,
"allow_change_general_data": true,
"allow_change_name": true,
"allow_change_organisation": true,
"allow_change_position": true,
"allow_change_department": true,
"allow_change_contact": true,
"allow_change_address": true,
"allow_change_description": true,
"allow_change_social_media": true,
"allow_change_focus": true,
"allow_change_color": true,
"allow_change_files": true,
"allow_change_frames": true,
"allow_use_services": true,
"allow_use_pushNotifications": true,
"allow_use_newsletter": true,
"allow_use_affiliate": false,
"allow_reorder_cards": false,
"allow_reorder_limit_period": "month",
"allow_reorder_limit_cards": 3,
"allow_display_statistics": true,
"allow_direct_links": true,
"allow_add_cards": true,
"allow_lock_products": true,
"allow_product_connect_sdc": true
}
},
"connected_cards": 0,
"access_pin": null,
"created_at": "2024-02-06T17:03:14.000000Z",
"updated_at": "2024-02-06T17:03:14.000000Z"
}
}Last updated