Clients

List clients

Return the address book of clients this account has sent intakes to. There is no clients table — this is a view over intakes, grouped case-insensitively by email, so it knows about every client from before this endpoint existed and can never drift from what was actually sent. name, language, phone, timezone and folder_id come from that client's most recent intake. Results are ordered by intake_count descending, then by last_intake_at descending. An API key sees only clients from intakes in its own mode (test/live), exactly like GET /v1/intakes.

get/v1/clients

Request

  • Base URL: https://api.briefgate.dev
  • URL: https://api.briefgate.dev/v1/clients
  • Auth: HTTP bearer

Query parameters

qstring

Case-insensitive substring search across the client's name and email address.

limitinteger

Number of results to return.

offsetinteger

Pagination offset.

Response

Paginated list of clients

totalinteger required
limitinteger required
offsetinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.