ONonesignal

Export subscriptions CSV

Generate a GZip-compressed CSV export of your current subscription data using this API endpoint.

post/players/csv_export

Request

  • Base URL
    https://api.onesignal.com
  • URL
    https://api.onesignal.com/players/csv_export
  • Auth
    none required

Query parameters

app_idstring required

Your OneSignal App ID in UUID v4 format. See Keys & IDs.

Headers

Authorizationstring required

Your App API key with prefix Key . See Keys & IDs.

Request body

extra_fieldsstring[]

Additional properties that you can include in the CSV.

last_active_sincestring

A Unix timestamp (in seconds) used to filter Subscriptions based on recent activity. Only Subscriptions with a last_session timestamp after this value will be included in the export. Example: To export Subscriptions active since January 1st, 2024, use 1704067200.

segment_namestring

The name of a specific segment to filter the export. Only subscriptions that belong to this segment will be included in the CSV. Omit this field to export all subscriptions in the app.

include_unsubscribedboolean

When used with segment_name, set to true to include unsubscribed subscriptions in the export. By default, segment-filtered exports only return subscribed subscriptions. This parameter has no effect when segment_name is not provided.

Response

200

csv_file_urlstring

The URL to download the CSV file. The file is available for 3 days after generation.

Changes

No recorded changes to this operation across all 2 revisions of this API.