MUmultigest
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

Request

  • Base URL
    https://api.multigest.pt (the document declares no server; this is the origin it was published from)
  • URL
    https://api.multigest.pt/api/clients
  • Auth
    API key in header x-api-token and API key in header x-origin-verify

Query parameters

skipinteger

Number of records to skip

limitinteger

Maximum records to return

qstring nullable

Search by name, NIF, email, or phone

pv_idinteger nullable

Filter by point of sale ID

particularboolean nullable

Filter by individual (true) or company (false)

recorrenteboolean nullable

Filter by recurring client

sortstring nullable

Sort order: 'id_desc' for newest first

include_inactiveboolean

Include deactivated clients (ativo=0)

Headers

x-api-tokenstring nullable

Response

Successful Response

object required

Changes

No recorded changes to this operation across all 21 revisions of this API.