Quick Search Clients

get

https://connect.agendapro.com/v3/clients/quick-search

This endpoint returns a small, ranked list of clients matching a free-text query. It searches by name, email, phone, identification number, and record number, and is intended for type-ahead / autocomplete use cases.

Errors Dictionary

Status	Error	Detail	Description
401	unauthorized	invalid_api_key	Missing or invalid Bearer token.
401	unauthorized	api_config_inactive	API access is inactive for this company.
403	forbidden	scope_denied	API key lacks `clients:read` scope.
400	bad_request	missing_q	Query string `q` is required.
429	rate_limited	burst_limit_exceeded	Per-minute request limit exceeded.
429	rate_limited	daily_quota_exceeded	Daily request quota exceeded.
502	upstream_unavailable		The upstream service is unavailable.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Ranked list of matching clients.

400Query string q is required.

401Missing or invalid Bearer API key, or inactive API configuration.

403API key lacks the required scope for this operation.

429Rate limit exceeded. Check the Retry-After header.

500Internal server error.

502Upstream service is unavailable.