Finding your API token

vcita users can find their API token via the vcita app, by navigating to Settings > Integrations, and click the Connect option under the Webhooks tile.

Sending your first API request to vcita platform

Example of an API request for getting business clients:

GET https://api.vcita.biz/platform/v1/clients

headers: {"Authorization": "Bearer YOUR_API_TOKEN"}

curl --request GET \
     --url https://api.vcita.biz/platform/v1/clients \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {YOUR_API_TOKEN}'

Example API Response

{
    "status": "OK",
    "data": {
        "clients": [
            {
                "id": "6vc9t1hthvlvz34f",
                "first_name": "Farah",
                "last_name": "Amar",
                "mobile_phone": null,
                "email": "[email protected]",
                "address": null,
                "created_at": "2021-08-12T13:03:47Z",
                "updated_at": "2021-10-13T09:37:37Z",
                "customer_status": "lead",
                "tags": [],
                "opt_in": null,
                "source": "Facebook",
                "source_url": null,
                "channel": null,
                "campaign": null,
                "business_uid": "ua48ta14yoqqz3r3"
            }
         [
     }
}