PushizoDocs
API reference

setup

setup — 2 operations (GET /v1/apps/{appId}/setup/status, GET /v1/apps/{appId}/setup/snippet). Generated from the OpenAPI 3.1.0 contract.

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

Operations

Details

Kurulum durumu: platformlar, kanal durumları, ilk abone, eksik adımlar ve panel bağlantıları

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

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: SetupStatus

FieldTypeRequiredDescription
app_idstringYes
namestringYes
platformsarray<string>Yes
frameworkstringYes
web_integrationstringYes
sdk_platformsarray<string>Yes
channelsarray<object>Yes
channels[].platformstringYes
channels[].channelstringYes
channels[].providerstring | nullYes
channels[].statusstringYes
first_subscriberbooleanYes
completedbooleanYes
missingarray<object>Yes
missing[].stepenumYesValues: "credentials", "install", "first_subscriber"
missing[].platformstringNo
missing[].channelstringNo
missing[].statusstringNo
missing[].local_uploadbooleanNo
missing[].sdk_platformsarray<string>No
missing[].urlstringYes
linksobjectYes
links.getting_startedstringYes
links.channelsstringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "channels": [
    "web_push"
  ],
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "platforms": [
    "örnek"
  ],
  "framework": "örnek",
  "web_integration": "örnek",
  "sdk_platforms": [
    "örnek"
  ],
  "first_subscriber": true,
  "completed": true,
  "missing": [
    {
      "url": "https://pushizo.com/orders/1001",
      "step": "credentials",
      "channel": "web_push",
      "status": "örnek",
      "platform": "örnek",
      "local_upload": true
    }
  ],
  "links": {
    "channels": "örnek",
    "getting_started": "ö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/setup/status" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

SDK kurulum kodu (panel rehberiyle aynı; platform, kod sekmesi ve not dili)

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

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

Parameters

NameInTypeRequiredDescriptionExample
platformqueryenumYesValues: "ios", "android", "flutter", "react-native", "expo", "capacitor", "cordova", "maui", "unity", "kmp", "windows", "web", "react", "nextjs", "vue", "angular", "wordpress", "gtm", "rest", "node", "php", "python", "go", "java", "csharp", "ruby", "rust""ios"
variantquerystringNoLength: 1–40"örnek"
langqueryenumNoValues: "en", "tr""en"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: SdkSnippet

FieldTypeRequiredDescription
platformstringYes
variantstring | nullYes
variantsarray<string>Yes
langstringYes
availabilityenumYesValues: "available", "soon"
docs_pathstring | nullYes
installarray<object>Yes
install[].keystringYes
install[].languagestringYes
install[].codestringYes
initarray<object>Yes
init[].keystringYes
init[].languagestringYes
init[].codestringYes
extrasarray<object>Yes
extras[].keystringYes
extras[].languagestringYes
extras[].codestringYes
android_modulesarray<object>Yes
android_modules[].modulestringYes
android_modules[].languagestringYes
android_modules[].codestringYes

Example response:

{
  "platform": "örnek",
  "variant": "örnek",
  "variants": [
    "örnek"
  ],
  "lang": "tr",
  "availability": "available",
  "docs_path": "örnek",
  "install": [
    {
      "key": "key-2026-10",
      "language": "tr",
      "code": "örnek"
    }
  ],
  "init": [
    {
      "key": "key-2026-10",
      "language": "tr",
      "code": "örnek"
    }
  ],
  "extras": [
    {
      "key": "key-2026-10",
      "language": "tr",
      "code": "örnek"
    }
  ],
  "android_modules": [
    {
      "module": "örnek",
      "language": "tr",
      "code": "ö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/setup/snippet?platform=ios" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

On this page