API Reference
Start typing to search…

Search Businesses

get
https://api.vcita.biz/platform/v1/businesses

Overview

Search for a business by external_reference_id or email.

Available for Directory Tokens only.

Note: At least one filter parameter (email, external_id, or external_reference_id) is required for the API to return a result.

Query Params
string

Filter by email specified (make sure its URL-encoded)

string

Filter by "external_id" specified. Deprecate. This will still work, but for new implementation please use external_reference_id.

string

Filter by "external_reference_id" specified

Response

Updated 2 months ago

Language
Credentials
Bearer
JWT
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 2 months ago