API Reference
  1. Viv Public API
  2. Clients

List clients

get
https://{apiHost}/api/v2/public/clients

Retrieve a paginated list of clients. Supports filtering by status, geo,
and last update time for incremental synchronization.

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

Maximum number of results to return (1-100)

integer
≥ 0
Defaults to 0

Number of results to skip for pagination

date-time

Return only records updated after this timestamp (ISO 8601)

string
enum

Filter by client status. Case-insensitive.

string

Filter by geographic location ID

string

Filter by case type ID. Get available case types from /config/attributes?type=caseType

string

Search clients by name, phone number, or email (case-insensitive partial match)

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?