Skip to main content
POST
Export subscribers

Restrictions

Usage

  • Requires the On-call Standard plan or higher; other accounts get AccessDenied.
  • The response is a text/csv attachment, not a JSON envelope, with the columns Method, Recipient, Components, Subscribe All (Yes/No), and Locale.
  • Components lists component names joined by , ; a component inside a section is written as Section › Component.
  • Public pages export email subscribers and internal pages export IM subscribers; filtering by component_ids also includes subscribers of all components.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json

Parameters for exporting a status page subscriber list.

page_id
integer<int64>
required

Status page ID; obtain it from GET /status-page/list.

component_ids
string[]

Optional component IDs to filter subscribers by.

Response

Success. CSV attachment, not a JSON envelope.

A CSV file (Content-Type: text/csv; charset=utf-8) containing columns: Method, Recipient, Components, Subscribe All, Locale.