Clients - Protected
List clients
List clients with pagination and filters. Results are scoped to the authenticated user's company. Deactivated clients are hidden unless include_inactive=true.
get/api/clients
Query parameters
skipinteger
Number of records to skip
Number of records to skip
limitinteger
Maximum records to return
Maximum records to return
qstring nullable
Search by name, NIF, email, or phone
Search by name, NIF, email, or phone
pv_idinteger nullable
Filter by point of sale ID
Filter by point of sale ID
particularboolean nullable
Filter by individual (true) or company (false)
Filter by individual (true) or company (false)
recorrenteboolean nullable
Filter by recurring client
Filter by recurring client
sortstring nullable
Sort order: 'id_desc' for newest first
Sort order: 'id_desc' for newest first
include_inactiveboolean
Include deactivated clients (ativo=0)
Include deactivated clients (ativo=0)
Headers
x-api-tokenstring nullable
Response
Successful Response
object required