Business Info

get

https://api.vcita.biz/v1/partners/reports/business

Overview

Query a business's basic information. If the email address already exists in our server you'll receive "status:existing".

Available for Directory tokens only.

Authentication

Uses HTTP Token authentication. Format: Authorization: Token token="{DIRECTORY_TOKEN}"

The token must be a Doorkeeper OAuth token with directory scope.

Query Params

string

required

Account owner email address. The email is used to look up the user and their associated business. If the user exists and belongs to the directory, full business details are returned. If the user exists but belongs to a different directory, a status of 'Existing' is returned.

from_date

date

Optional start date for campaign usage reporting period. Format: yyyy-mm-dd. Defaults to the beginning of the current month if not provided. Must be provided together with to_date.

to_date

date

Optional end date for campaign usage reporting period. Format: yyyy-mm-dd. Defaults to the end of the current month if not provided. Must be provided together with from_date.

Headers

Authorization

string

required

HTTP Token authentication. Format: Token token="{DIRECTORY_TOKEN}". The token must have directory scope.

Responses

Language

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200 - Returns business details when the email matches a user in the directory, or a status of 'Existing' when the user exists but belongs to a different directory.

400400 - Returned when the provided email does not match any existing user in the system, or when the date format is invalid.

401401

422422