Skip to navigation
WhizBoard APIFirms

List Clients

View as Markdown

List client members for a firm with upload summary fields.

Requires that the authenticated user is a member of the firm.

Authentication

Authorizationstring
API Key authentication via header

Path parameters

firm_slugstringRequired3-64 characters

Query parameters

pageintegerOptional>=1Defaults to 1
page_sizeintegerOptional1-100Defaults to 20
searchstring or nullOptional>=1 character
Search by client name
sortlist of stringsOptionalDefaults to ["priority:desc","last_file_modified:desc"]

Multi-sort as repeated values or comma-separated values. Allowed fields: name, priority, last_file_modified, completed_files_uploaded_count, user_id, member_id. Example: sort=priority:desc,last_file_modified:desc

label_idslist of integersOptionalDefaults to []

Filter by label ids. Repeat label_ids or pass multiple values.

label_matchenumOptionalDefaults to any
Allowed values:

Response

Successful Response
dataobject
statusstringOptionalDefaults to success

Errors

422
Unprocessable Entity Error