Skip to content
/Clients

Search clients

Request

Paginated search of clients with filtering and sorting. Supports page, limit, sort, and filters (name, dot, agencyId, producerId, parentClientId, deleted, clientTypeId, acordEnabled).

Security
BearerAuth and ApiKeyAuth
Query
pageinteger, >= 1

Page number (1-based).

Default:1
limitinteger, [ 1 .. 1000 ]

Items per page (1-1000).

Default:100
sortstring

Sort field (e.g. -clientName for descending).

namestring

Filter by client name (partial match).

dotstring

Filter by DOT number.

agencyIdinteger or null

Filter by agency ID.

producerIdinteger or null

Filter by producer ID.

parentClientIdinteger or null

Filter by parent client ID.

deletedboolean or null

Filter by deleted status.

clientTypeIdinteger or null

Filter by client type ID.

acordEnabledboolean or null

Filter by ACORD enabled.

curl -i -X GET \
  'https://docs.meshvi.com/_mock/apis/meshvi/v1/clients?page=1&limit=100&sort=string&name=string&dot=string&agencyId=0&producerId=0&parentClientId=0&deleted=true&clientTypeId=0&acordEnabled=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'apiKey: YOUR_API_KEY_HERE'

Responses

Paginated list of clients.