Push
Get Push Settings
Read web push, APNs and Firebase readiness and device counts
GET
/
api
/
v1
/
push
/
settings
Get Push Settings
curl --request GET \
--url https://api.sequenzy.com/api/v1/push/settings \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sequenzy.com/api/v1/push/settings"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.sequenzy.com/api/v1/push/settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sequenzy.com/api/v1/push/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.sequenzy.com/api/v1/push/settings"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sequenzy.com/api/v1/push/settings")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sequenzy.com/api/v1/push/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"push": {
"web": {
"enabled": true,
"vapidPublicKey": "BH3tXU0JSzok9ND7DyeQRcEy..."
},
"ios": {
"configured": true,
"keyId": "ABC123DEFG",
"teamId": "DEF123GHIJ",
"bundleId": "com.example.app",
"environment": "production",
"lastError": null,
"lastErrorAt": null
},
"android": {
"configured": false,
"projectId": null,
"clientEmail": null,
"lastError": null,
"lastErrorAt": null
},
"defaultIconUrl": "https://cdn.example.com/icon-192.png",
"brandIconUrl": "https://cdn.example.com/logo.png",
"devices": {
"active": {
"web": 1204,
"ios": 312,
"android": 0
},
"identifiedActive": 980,
"totalActive": 1516
}
},
"message": "Push is ready for web, iOS."
}
{
"error": "Invalid API key"
}
{
"error": "API key is missing required scope: account:read"
}
Get Push Settings
Returns whether web push is on (with the VAPID public key browsers subscribe with), whether APNs (iOS) and Firebase (Android) credentials are connected, the last credential error for each platform, the default icon, the brand icon used when no default icon is set, and active device counts. Secrets are never returned. Requires theaccount:read scope.
See Push notifications for setup.
Request
No parameters. PassX-Company-Id if your API key has access to multiple companies.
curl "https://api.sequenzy.com/api/v1/push/settings" \
--header "Authorization: Bearer $SEQUENZY_API_KEY"
Responses
{
"success": true,
"push": {
"web": {
"enabled": true,
"vapidPublicKey": "BH3tXU0JSzok9ND7DyeQRcEy..."
},
"ios": {
"configured": true,
"keyId": "ABC123DEFG",
"teamId": "DEF123GHIJ",
"bundleId": "com.example.app",
"environment": "production",
"lastError": null,
"lastErrorAt": null
},
"android": {
"configured": false,
"projectId": null,
"clientEmail": null,
"lastError": null,
"lastErrorAt": null
},
"defaultIconUrl": "https://cdn.example.com/icon-192.png",
"brandIconUrl": "https://cdn.example.com/logo.png",
"devices": {
"active": {
"web": 1204,
"ios": 312,
"android": 0
},
"identifiedActive": 980,
"totalActive": 1516
}
},
"message": "Push is ready for web, iOS."
}
{
"error": "Invalid API key"
}
{
"error": "API key is missing required scope: account:read"
}
⌘I
Get Push Settings
curl --request GET \
--url https://api.sequenzy.com/api/v1/push/settings \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sequenzy.com/api/v1/push/settings"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.sequenzy.com/api/v1/push/settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sequenzy.com/api/v1/push/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.sequenzy.com/api/v1/push/settings"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sequenzy.com/api/v1/push/settings")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sequenzy.com/api/v1/push/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"push": {
"web": {
"enabled": true,
"vapidPublicKey": "BH3tXU0JSzok9ND7DyeQRcEy..."
},
"ios": {
"configured": true,
"keyId": "ABC123DEFG",
"teamId": "DEF123GHIJ",
"bundleId": "com.example.app",
"environment": "production",
"lastError": null,
"lastErrorAt": null
},
"android": {
"configured": false,
"projectId": null,
"clientEmail": null,
"lastError": null,
"lastErrorAt": null
},
"defaultIconUrl": "https://cdn.example.com/icon-192.png",
"brandIconUrl": "https://cdn.example.com/logo.png",
"devices": {
"active": {
"web": 1204,
"ios": 312,
"android": 0
},
"identifiedActive": 980,
"totalActive": 1516
}
},
"message": "Push is ready for web, iOS."
}
{
"error": "Invalid API key"
}
{
"error": "API key is missing required scope: account:read"
}