REST API
Integrations
REST API
The documentation of the api can be found in Api Docs page. This article defines the resources available in the Vcards integration API.
Access token
In order to access the API it is required having an accessToken. Once you have an accessToken you must include it in every request as a HTTP header
AccessToken: "AccessToken"
If you need to try different API calls you can do it from the same Api Docs page, by using the "authorize" button
List Tags
Tag detail
GET /api/integration/tags/{sku}
Description:
Retrieves tag details by the given SKU. The SKU is a unique reference for the tag.
Parameters:
| Name | Type | Description | Required |
|---|---|---|---|
| sku | string | SKU code | Yes |
- sku: A string representing the SKU (Stock Keeping Unit) used to retrieve specific tag details.
Responses:
200 - Success
-
Media type:
application/json -
Example response:
{ "code": "BVHWSTMGL", "sku": "ABC000", "values": { "name": "Full name", "email": "[email protected]", "phone": "+1234567890", "position": { "en": "CEO", "es": "Director General" }, "mobile-phone": "+1234567890", "address": "1234 Main St, City, Country", "department" : "Marketing" } }
404 - Not Found
- Description: Tag not found in the team for the given SKU.