PushizoDocs
API reference

Export / import

Export / import — 6 operations (GET /v1/apps/{appId}/exports, POST /v1/apps/{appId}/exports, GET /v1/apps/{appId}/exports/{exportId}, …). Generated from the OpenAPI 3.1.0 contract.

CSV export jobs (users, subscriptions, events, deliveries) and imports (Pushizo CSV, legacy provider player CSV; multipart).

Base URL: https://api.pushizo.com · Tag: exports · Interactive docs (Scalar)

Operations

MethodPathOperation
GET/v1/apps/{appId}/exportsExport jobs
POST/v1/apps/{appId}/exportsStart an export job
GET/v1/apps/{appId}/exports/{exportId}Export status (download_url)
GET/v1/apps/{appId}/importsImport jobs
POST/v1/apps/{appId}/importsStart an import job (multipart: type, file)
GET/v1/apps/{appId}/imports/{importId}Import status

Details

Export jobs

GET/v1/apps/{appId}/exportsTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
limitqueryintegerNoDefault: 50; Range: 1–10050
cursorquerystringNoLength: 1–∞"eyJpZCI6Im1zZ18wMUpE…"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: ExportList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].typeenumYesValues: "users", "subscriptions", "events", "deliveries", "message_events"
data[].filtersobjectYes
data[].filters.fromstring (date-time)No
data[].filters.tostring (date-time)No
data[].filters.namestringNoLength: 0–100
data[].filters.message_idstringNoLength: 0–64
data[].filters.campaign_idstringNoLength: 0–64
data[].filters.statusstringNoLength: 0–32
data[].filters.channelenumNoValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
data[].filters.segment_idstringNoLength: 0–64
data[].statusenumYesValues: "pending", "running", "completed", "failed"
data[].row_countinteger | nullYes
data[].errorstring | nullYes
data[].download_urlstring | nullYes
data[].expires_atstring | nullYes
data[].requested_bystring | nullYes
data[].created_atstringYes
data[].completed_atstring | nullYes
next_cursorstring | nullYes
has_morebooleanYes

Example response:

{
  "data": [
    {
      "type": "users",
      "status": "pending",
      "id": "exp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "filters": {
        "name": "Sipariş bildirimleri",
        "channel": "ios_push"
      },
      "row_count": 1,
      "error": "örnek",
      "download_url": "https://pushizo.com/orders/1001",
      "expires_at": "örnek",
      "requested_by": "örnek",
      "created_at": "örnek",
      "completed_at": "örnek"
    }
  ],
  "next_cursor": "eyJpZCI6Im1zZ18wMUpE…",
  "has_more": true
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/exports?limit=50" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Start an export job

POST/v1/apps/{appId}/exportsTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreateExportDto

FieldTypeRequiredDescription
typeenumYesValues: "users", "subscriptions", "events", "deliveries", "message_events"
filtersobjectNoDefault: {}
filters.fromstring (date-time)No
filters.tostring (date-time)No
filters.namestringNoLength: 0–100
filters.message_idstringNoLength: 0–64
filters.campaign_idstringNoLength: 0–64
filters.statusstringNoLength: 0–32
filters.channelenumNoValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
filters.segment_idstringNoLength: 0–64

Example:

{
  "type": "users",
  "filters": {}
}

Responses

200 — Success.

Schema: Export

FieldTypeRequiredDescription
idstringYes
app_idstringYes
typeenumYesValues: "users", "subscriptions", "events", "deliveries", "message_events"
filtersobjectYes
filters.fromstring (date-time)No
filters.tostring (date-time)No
filters.namestringNoLength: 0–100
filters.message_idstringNoLength: 0–64
filters.campaign_idstringNoLength: 0–64
filters.statusstringNoLength: 0–32
filters.channelenumNoValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
filters.segment_idstringNoLength: 0–64
statusenumYesValues: "pending", "running", "completed", "failed"
row_countinteger | nullYes
errorstring | nullYes
download_urlstring | nullYes
expires_atstring | nullYes
requested_bystring | nullYes
created_atstringYes
completed_atstring | nullYes

Example response:

{
  "type": "users",
  "status": "pending",
  "id": "exp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "filters": {
    "name": "Sipariş bildirimleri",
    "channel": "ios_push",
    "status": "örnek",
    "from": "2026-10-17T09:00:00Z"
  },
  "row_count": 1,
  "error": "örnek",
  "download_url": "https://pushizo.com/orders/1001",
  "expires_at": "örnek",
  "requested_by": "örnek",
  "created_at": "örnek",
  "completed_at": "örnek"
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/exports" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "users",
  "filters": {}
}'

Export status (download_url)

GET/v1/apps/{appId}/exports/{exportId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
exportIdpathstringYes"exp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Export

FieldTypeRequiredDescription
idstringYes
app_idstringYes
typeenumYesValues: "users", "subscriptions", "events", "deliveries", "message_events"
filtersobjectYes
filters.fromstring (date-time)No
filters.tostring (date-time)No
filters.namestringNoLength: 0–100
filters.message_idstringNoLength: 0–64
filters.campaign_idstringNoLength: 0–64
filters.statusstringNoLength: 0–32
filters.channelenumNoValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
filters.segment_idstringNoLength: 0–64
statusenumYesValues: "pending", "running", "completed", "failed"
row_countinteger | nullYes
errorstring | nullYes
download_urlstring | nullYes
expires_atstring | nullYes
requested_bystring | nullYes
created_atstringYes
completed_atstring | nullYes

Example response:

{
  "type": "users",
  "status": "pending",
  "id": "exp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "filters": {
    "name": "Sipariş bildirimleri",
    "channel": "ios_push",
    "status": "örnek",
    "from": "2026-10-17T09:00:00Z"
  },
  "row_count": 1,
  "error": "örnek",
  "download_url": "https://pushizo.com/orders/1001",
  "expires_at": "örnek",
  "requested_by": "örnek",
  "created_at": "örnek",
  "completed_at": "örnek"
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/exports/exp_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Import jobs

GET/v1/apps/{appId}/importsTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
limitqueryintegerNoDefault: 50; Range: 1–10050
cursorquerystringNoLength: 1–∞"eyJpZCI6Im1zZ18wMUpE…"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: ImportList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].typeenumYesValues: "legacy_players", "csv_users"
data[].file_namestring | nullYes
data[].statusenumYesValues: "pending", "running", "completed", "failed"
data[].statsobjectYes
data[].stats.processedintegerNo
data[].stats.created_usersintegerNo
data[].stats.updated_usersintegerNo
data[].stats.created_subscriptionsintegerNo
data[].stats.skippedintegerNo
data[].stats.errorsintegerNo
data[].stats.rejected_emailsintegerNo
data[].stats.rejected_email_reasonsmap<string, integer>No
data[].errorstring | nullYes
data[].error_report_urlstring | nullYes
data[].requested_bystring | nullYes
data[].created_atstringYes
data[].completed_atstring | nullYes
next_cursorstring | nullYes
has_morebooleanYes

Example response:

{
  "data": [
    {
      "type": "legacy_players",
      "status": "pending",
      "id": "exp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "file_name": "örnek",
      "stats": {
        "processed": 1,
        "created_users": 1
      },
      "error": "örnek",
      "error_report_url": "https://pushizo.com/orders/1001",
      "requested_by": "örnek",
      "created_at": "örnek",
      "completed_at": "örnek"
    }
  ],
  "next_cursor": "eyJpZCI6Im1zZ18wMUpE…",
  "has_more": true
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/imports?limit=50" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Start an import job (multipart: type, file)

POST/v1/apps/{appId}/importsTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Content type: multipart/form-data.

FieldTypeRequiredDescription
typeenumYesValues: "legacy_players", "csv_users"
filestring (binary)YesCSV file (UTF-8, up to 50 MB)

Example:

{
  "type": "legacy_players",
  "file": "örnek"
}

Responses

200 — Success.

Schema: Import

FieldTypeRequiredDescription
idstringYes
app_idstringYes
typeenumYesValues: "legacy_players", "csv_users"
file_namestring | nullYes
statusenumYesValues: "pending", "running", "completed", "failed"
statsobjectYes
stats.processedintegerNo
stats.created_usersintegerNo
stats.updated_usersintegerNo
stats.created_subscriptionsintegerNo
stats.skippedintegerNo
stats.errorsintegerNo
stats.rejected_emailsintegerNo
stats.rejected_email_reasonsmap<string, integer>No
errorstring | nullYes
error_report_urlstring | nullYes
requested_bystring | nullYes
created_atstringYes
completed_atstring | nullYes

Example response:

{
  "type": "legacy_players",
  "status": "pending",
  "id": "imp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "file_name": "örnek",
  "stats": {
    "processed": 1,
    "created_users": 1,
    "updated_users": 1,
    "created_subscriptions": 1
  },
  "error": "örnek",
  "error_report_url": "https://pushizo.com/orders/1001",
  "requested_by": "örnek",
  "created_at": "örnek",
  "completed_at": "örnek"
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/imports" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -F "type=legacy_players" \
  -F "file=@users.csv"

Import status

GET/v1/apps/{appId}/imports/{importId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
importIdpathstringYes"imp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Import

FieldTypeRequiredDescription
idstringYes
app_idstringYes
typeenumYesValues: "legacy_players", "csv_users"
file_namestring | nullYes
statusenumYesValues: "pending", "running", "completed", "failed"
statsobjectYes
stats.processedintegerNo
stats.created_usersintegerNo
stats.updated_usersintegerNo
stats.created_subscriptionsintegerNo
stats.skippedintegerNo
stats.errorsintegerNo
stats.rejected_emailsintegerNo
stats.rejected_email_reasonsmap<string, integer>No
errorstring | nullYes
error_report_urlstring | nullYes
requested_bystring | nullYes
created_atstringYes
completed_atstring | nullYes

Example response:

{
  "type": "legacy_players",
  "status": "pending",
  "id": "imp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "file_name": "örnek",
  "stats": {
    "processed": 1,
    "created_users": 1,
    "updated_users": 1,
    "created_subscriptions": 1
  },
  "error": "örnek",
  "error_report_url": "https://pushizo.com/orders/1001",
  "requested_by": "örnek",
  "created_at": "örnek",
  "completed_at": "örnek"
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/imports/imp_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

On this page