Docs API Reference Newsletter/bff/newsletter/job-list

/bff/newsletter/job-list

Returns a paginated list of newsletter sending jobs with their progress and speed limits. Pass segmentId to scope the list to a specific contact segment (used by the segment detail "history" tab).

NewslettergetBffNewsletterJob-list

Parameters

3 query

Query parameters

· 3

pagestringOptional

Page number (1-based) for pagination.

Example1

limitstringOptional

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

Example50

segmentIdstringOptional

External ID of a contact segment to filter by. When set, only jobs that were fired from this segment are returned. Internal numeric IDs are resolved server-side.

Exampleexample_segmentId

Response schema

1 status code documented

200Success

This response returns no JSON body.

Response example

application/json

{
  "success": true
}

Request example

GET /bff/newsletter/job-list

get

curl -X GET "https://api.bizkithub.com/bff/newsletter/job-list?page=1&limit=50&segmentId=example_segmentId" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key