v4
OpenAPI 3.1.02026-08-03427198448.4 KBinternal
List Clients
List clients with optional filters.
get/api/internal/clients
Query parameters
user_idstring
org_idstring
namestring nullable
Partial match on client name
Partial match on client name
is_archivedboolean nullable
Filter by archived status
Filter by archived status
order_bystring nullable
Column to sort by (e.g., name, created_at, updated_at)
Column to sort by (e.g., name, created_at, updated_at)
order_descboolean nullable
Sort in descending order
Sort in descending order
include_contactsboolean
Include client contacts in response
Include client contacts in response
limitinteger
Maximum number of clients to return
Maximum number of clients to return
offsetinteger
Number of clients to skip
Number of clients to skip
Response
Successful Response
{"stackTrail":"paths:/api/internal/clients:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}