Public API Reference (Beta)Clients/DepartmentsCore

List clients

Returns a paginated list of active clients for the authenticated user’s company. Optionally filter by company name using q (case-insensitive contains).

Authentication

X-Brightmove-Company-ApiKeystring
BrightMove Company Api Key
X-Brightmove-User-ApiKeystring
BrightMove User Api Key

Query parameters

pageintegerOptionalDefaults to 0

Zero-based page number

sizeintegerOptionalDefaults to 25

Number of items per page (max 100)

qstringOptional

Optional case-insensitive company name filter

Response

Paginated list of clients returned