Skip to main content

Get vCard by Slug (v1)

Method + Path

GET /v1/public/vcards/:slug

Actual backend path: /v1/public/vcards/:slug

Description

Get a public vCard by its slug. vCards are digital business cards that can be shared publicly.

Authentication

Not required - This is a public endpoint

Headers

HeaderTypeRequiredDescription
Content-TypestringYesapplication/json

Path Parameters

ParameterTypeRequiredDescription
slugstringYesvCard slug

Query Parameters

ParameterTypeRequiredDescription
previewstringNoPreview mode. Valid values: true, false. Default: false

Response (200)

{
"vcard": {
"id": "507f1f77bcf86cd799439011",
"slug": "john-doe",
"name": "John Doe",
"title": "Software Engineer",
"email": "john@example.com",
"phone": "+1234567890",
"storeSlug": "my-store",
"storeCurrency": "USD"
}
}

Common Errors

  • 404 Not Found: vCard not found or not published
  • 500 Internal Server Error: Server error