API Reference

Get a list of Businesses

get
https://api.vcita.biz/v3/business_administration/businesses

Returns a filtered, paginated list of businesses belonging to the authenticated directory.

Available for Directory,Staff and Internal tokens.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
Defaults to 1

Page number for pagination.

integer
≤ 200
Defaults to 25

Number of businesses to return per page. Maximum is 200.

string

Filter businesses by name. Supports partial match.

string

Search businesses by external ID (searches across external_reference_id and reference_id).

tags
array of strings

Filter businesses by one or more tags (comma-separated). Returns businesses that match any of the provided tags.

tags
string

Filter businesses by the exact external reference ID assigned by the directory.

string

Filter businesses by owner email address.

string

Filter businesses by directory UID. Available for Internal tokens only, where it is required. Ignored for Directory tokens (which are scoped to their own directory).

package_name
array of strings

Filter businesses by their current subscription package name. Accepts a comma-separated list to match any of several packages (e.g. "essential,business").

package_name
boolean

Filter businesses by blocked status. Set to true to return only blocked businesses, false to return only active businesses.

Responses

Updated 20 days ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 20 days ago