List customer group reminders

GET

customer_groups

{id}

reminders

curl --request GET \
  --url https://api.staging.streamlinedpayments.com/api/v1/customer_groups/{id}/reminders \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-App-Id: <api-key>'

const options = {method: 'GET', headers: {'X-App-Id': '<api-key>', 'X-Api-Key': '<api-key>'}};

fetch('https://api.staging.streamlinedpayments.com/api/v1/customer_groups/{id}/reminders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.staging.streamlinedpayments.com/api/v1/customer_groups/{id}/reminders"

headers = {
    "X-App-Id": "<api-key>",
    "X-Api-Key": "<api-key>"
}

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

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://api.staging.streamlinedpayments.com/api/v1/customer_groups/{id}/reminders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-App-Id"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "sent_count": 3,
  "data": [
    {
      "sent_at": "2026-10-20",
      "invoice_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "identifier": "INV-2041",
      "open_count": 2,
      "bounced": true
    }
  ],
  "meta": {
    "current_page": 123,
    "per_page": 123,
    "total_pages": 123,
    "total_count": 123
  }
}

Authorizations

X-App-Id

string

header

required

App ID for authentication

X-Api-Key

string

header

required

API Key for authentication

Path Parameters

string<uuid>

required

The customer group's UUID.

Query Parameters

days

integer

default:60

Number of days back to read.

Required range: 1 <= x <= 365

page

integer

default:1

Page number, from 1 to 10000.

Required range: 1 <= x <= 10000

per_page

integer

default:20

Number of rows per page, from 1. Values above 100 are treated as 100.

Required range: x >= 1

Response

Successful operation

sent_count

integer

Number of reminders sent in the window, across every page.

Example:

3

data

object[]

Show child attributes

meta

object

Show child attributes

List customer group reminders

curl --request GET \
  --url https://api.staging.streamlinedpayments.com/api/v1/customer_groups/{id}/reminders \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-App-Id: <api-key>'

const options = {method: 'GET', headers: {'X-App-Id': '<api-key>', 'X-Api-Key': '<api-key>'}};

fetch('https://api.staging.streamlinedpayments.com/api/v1/customer_groups/{id}/reminders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.staging.streamlinedpayments.com/api/v1/customer_groups/{id}/reminders"

headers = {
    "X-App-Id": "<api-key>",
    "X-Api-Key": "<api-key>"
}

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

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://api.staging.streamlinedpayments.com/api/v1/customer_groups/{id}/reminders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-App-Id"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "sent_count": 3,
  "data": [
    {
      "sent_at": "2026-10-20",
      "invoice_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "identifier": "INV-2041",
      "open_count": 2,
      "bounced": true
    }
  ],
  "meta": {
    "current_page": 123,
    "per_page": 123,
    "total_pages": 123,
    "total_count": 123
  }
}

Orders

Customers

Customer applications

Customer groups

Customer files

Customer addresses

Payouts

Invoices

Transactions

Products

Deposit links

Webhooks

Reports

List customer group reminders

Authorizations

Path Parameters

Query Parameters

Response