`postscript_list_subscribers`

Pack: postscript · Endpoint: https://gateway.pipeworx.io/postscript/mcp

List SMS subscribers for a Postscript (Shopify) shop. Supports filtering by email, phone number, Shopify customer ID, and created/updated timestamps, plus sorting. Page-based pagination: returns { page_info: { page, total_pages }, subscribers: […] }; pass page to walk results.

Parameters

Name	Type	Required	Description
`_apiKey`	string	yes	Postscript Private API token (Bearer). From Settings → API.
`page`	number	no	1-indexed page number (default 1). Walk until page === page_info.total_pages.
`sort`	string	no	Sort spec like “created_at__desc” or “updated_at__asc”.
`email__eq`	string	no	Exact email match.
`email__contains`	string	no	Substring email match.
`phone_number__eq`	string	no	Exact phone match (E.164, e.g. +15551234567).
`phone_number__contains`	string	no	Substring phone match.
`shopify_customer_id__eq`	string	no	Exact Shopify customer ID match.
`created_at__gte`	string	no	ISO timestamp; subscribers created on/after this time.
`created_at__lte`	string	no	ISO timestamp; subscribers created on/before this time.
`updated_at__gte`	string	no	ISO timestamp; subscribers updated on/after this time.

Example call

Arguments

{
  "_apiKey": "your-postscript-api-key",
  "page": 1,
  "sort": "created_at__desc"
}

curl

curl -X POST https://gateway.pipeworx.io/postscript/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"postscript_list_subscribers","arguments":{"_apiKey":"your-postscript-api-key","page":1,"sort":"created_at__desc"}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('postscript_list_subscribers', {
  "_apiKey": "your-postscript-api-key",
  "page": 1,
  "sort": "created_at__desc"
});

More examples

{
  "_apiKey": "your-postscript-api-key",
  "phone_number__eq": "+15551234567",
  "created_at__gte": "2024-01-01T00:00:00Z"
}

Connect

Add this to your MCP client config, or use one-click install buttons:

{
  "mcpServers": {
    "postscript": {
      "url": "https://gateway.pipeworx.io/postscript/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

postscript_list_subscribers