API Reference

Get Clients

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

Overview

Retrieves a paginated list of clients for the business. Supports searching by various attributes and filtering by update timestamp.

Authentication

Available for Staff, App, and Directory Tokens.

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

Search Term

string

Search By - email/uid/phone/updated_at

string

Specify the updated_at filter range, available operators for updated_at: gte, lte. example: updated_at[gte]=2019-01-01

integer

Page number of results. Default: 1

integer

How many items to return per page. Default: 25. Max: 100

Responses

422

Unprocessable Entity - Invalid request parameters

429

Too Many Requests - Rate limit exceeded for this business

Updated 3 months ago

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

Updated 3 months ago