List signups

GET

/back_in_stock/signups

curl --request GET \
  --url 'https://app.stoqapp.com/api/v2/external/back_in_stock/signups?channel=email&status=pending&variant_id=45000000001&product_id=78000000001&query=string&email=shopper%40example.com&phone=%2B15551234567&from=string&to=string&page=string&per_page=string' \
  --header 'X-Auth-Token: <X-Auth-Token>'

• Production

List back-in-stock signups (the waitlist) in this shop, paginated.

Note: status compiles notified_at / unsubscribed_at / blocked_at into one lifecycle value; email and phone filters match partial values on the signup or its customer; query matches the customer’s name, email or phone with one term (use email/phone instead to match only one). summary counts every signup matching the filters by status (total, pending, notified, blocked, unsubscribed), not only this page. A bare from/to date is that whole day in the shop’s time zone.

Authorizations

• ApiKeyAuth

Parameters

Query Parameters

channel

Allowed values: email sms push

Example

email

status

Allowed values: pending notified blocked unsubscribed

Example

pending

variant_id

Example

45000000001

product_id

Example

78000000001

query

Example

string

email

Example

shopper@example.com

phone

Example

+15551234567

from

Example

string

to

Example

string

page

Example

string

per_page

Example

string

Responses

200

Success — example response shown.

Media typeapplication/json

object

Example

{
  "signups": [
    {
      "id": 5847392,
      "status": "pending",
      "channel": "email",
      "contact": "john@example.com",
      "quantity": 2,
      "variant": {
        "shopify_variant_id": 47284734423096,
        "shopify_product_id": 8784906035384,
        "title": "Blue / Medium"
      },
      "customer": {
        "id": 9284756,
        "email": "john@example.com",
        "name": "John Doe"
      },
      "notifications_sent": 0,
      "last_notified_at": null,
      "created_at": "2026-06-25T13:45:30Z"
    },
    {
      "id": 5847393,
      "status": "notified",
      "channel": "sms",
      "contact": "+14155552671",
      "quantity": 1,
      "variant": {
        "shopify_variant_id": 47284734455864,
        "shopify_product_id": 8784906035384,
        "title": "Red / Large"
      },
      "customer": {
        "id": 9284757,
        "email": "jane@example.com",
        "name": "Jane Smith"
      },
      "notifications_sent": 1,
      "last_notified_at": "2026-06-24T10:30:00Z",
      "created_at": "2026-06-20T15:20:15Z"
    }
  ],
  "meta": {
    "total_count": 147,
    "page": 1,
    "per_page": 50,
    "total_pages": 3
  }
}

401

Missing or invalid X-Auth-Token.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Unauthorized"
  ]
}

422

The request failed validation.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "name is required"
  ]
}

429

Rate limited — cost-weighted per token (read 1, write 2; 360 points / 60s). Check Retry-After.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Rate limit exceeded"
  ]
}