Clients

List clients

Returns a paginated list of clients. Supports search and type filtering.

get/clients

Request

  • Base URL: https://api.heffl.com/api/v2
  • URL: https://api.heffl.com/api/v2/clients
  • Auth: API key in header x-api-key

Query parameters

cursorstring

Cursor for pagination. Pass the previous response nextCursor value to fetch the next page.

limitnumber

Number of items to return (max 100)

searchstring

Search by name, email, or phone

type'company' | 'contact'

Filter by client type

Response

OK

nextCursorstring nullable

Cursor to fetch the next page. Null if there are no more results.

hasMoreboolean required

Whether additional results are available

Changes

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