/bff/emailer/list

Returns a paginated list of email messages for the current organisation with optional filters.

EmailergetBffEmailerList

Parameters

6 query

6 total

Query · 6

pagestring

Page number (1-based) for pagination.

limitstring

Maximum items per page (1–500, default 50).

statusstring

Filter by message status code.

tagstring

Filter by message tag.

emailToContactIdstring

Filter by recipient contact external ID.

filterFulltextQuerystring

Fulltext query — searches subject, body and sender/recipient name & email.

Request

GET /bff/emailer/list

get

curl -X GET "https://api.bizkithub.com/bff/emailer/list?page=1&limit=50&status=example_status&tag=example_tag&emailToContactId=example_emailToContactId&filterFulltextQuery=example_filterFulltextQuery" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

JSON payload

{
  "success": true
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key