TypeScript SDK

import { Configuration, PartnersApi } from '@widgetic/api-sdk-ts';

const partnersApi = new PartnersApi(new Configuration({ apiKey: 'YOUR_API_KEY' }));

// The latest notifications, then the ones before them:
const { data: page } = await partnersApi.listPartnerNotifications({ partnerId, limit: 20 });
const older = page.nextBefore
  ? await partnersApi.listPartnerNotifications({ partnerId, before: page.nextBefore })
  : null;

import requests

url = "https://api.widgetic.com/v1/partners/{partnerId}/notifications"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.widgetic.com/v1/partners/{partnerId}/notifications', 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.widgetic.com/v1/partners/{partnerId}/notifications",
  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.widgetic.com/v1/partners/{partnerId}/notifications"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.widgetic.com/v1/partners/{partnerId}/notifications")

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,
  "data": {
    "notifications": [
      "Example PartnerNotification"
    ],
    "nextBefore": "2026-01-15T09:30:00.000Z"
  },
  "meta": {
    "page": 1,
    "size": 20,
    "total": 135,
    "limit": 20,
    "offset": 0,
    "hasNextPage": true,
    "hasPreviousPage": false,
    "nextCursor": "<string>",
    "warnings": [
      "<string>"
    ]
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

Partners

What your partner account was told

Lists the notifications of a partner, the newest first: the invoices Widgetic issued and their payments, the reminders to pay them, a warning when your credits run low, and the changes to the standing of the account (activated, paused, resumed). It is the same list your dashboard shows, and each entry is what your webhook receives as data when you have one (updatePartnerNotificationSettings).

A page holds limit notifications (20 by default, at most 100). When there are older ones nextBefore is set: ask again with it as before to get the next page.

The caller must be the person who administers the partner (an API key of that account works, with the partner:read scope), or a Widgetic administrator.

GET

partners

{partnerId}

notifications

TypeScript SDK

import { Configuration, PartnersApi } from '@widgetic/api-sdk-ts';

const partnersApi = new PartnersApi(new Configuration({ apiKey: 'YOUR_API_KEY' }));

// The latest notifications, then the ones before them:
const { data: page } = await partnersApi.listPartnerNotifications({ partnerId, limit: 20 });
const older = page.nextBefore
  ? await partnersApi.listPartnerNotifications({ partnerId, before: page.nextBefore })
  : null;

import requests

url = "https://api.widgetic.com/v1/partners/{partnerId}/notifications"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.widgetic.com/v1/partners/{partnerId}/notifications', 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.widgetic.com/v1/partners/{partnerId}/notifications",
  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.widgetic.com/v1/partners/{partnerId}/notifications"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.widgetic.com/v1/partners/{partnerId}/notifications")

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,
  "data": {
    "notifications": [
      "Example PartnerNotification"
    ],
    "nextBefore": "2026-01-15T09:30:00.000Z"
  },
  "meta": {
    "page": 1,
    "size": 20,
    "total": 135,
    "limit": 20,
    "offset": 0,
    "hasNextPage": true,
    "hasPreviousPage": false,
    "nextCursor": "<string>",
    "warnings": [
      "<string>"
    ]
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

partnerId

string<uuid>

required

The partner whose notifications to list

Query Parameters

limit

integer

default:20

How many notifications to list at most

Required range: 1 <= x <= 100

before

string<date-time>

Only the notifications made before this moment. Give the nextBefore of the previous page.

Response

The notifications, the newest first

success

boolean

required

Always true on a success.

Example:

true

data

object

required

A page of notifications, the newest first.

Show child attributes

Example:

{
  "notifications": ["Example PartnerNotification"],
  "nextBefore": "2026-01-15T09:30:00.000Z"
}

API Reference

Public Embed

Workflows

Partners

Widgets

Users

Uploads

Tokens

Operations

Managed Users

Invoices

Entitlements

Credits

Compositions

Canvases

Brand Kit

What your partner account was told

Authorizations

Path Parameters

Query Parameters

Response