Get a signup
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/back_in_stock/signups/{id}Costs 1 rate-limit point · Rate limits
Read one back-in-stock signup's full representation.
Find ids with GET /back_in_stock/signups. notifications_count counts alerts that went out, not blocked sends; each send with its delivery events is GET /back_in_stock/signups/:id/history. A signup whose product or variant was deleted in Shopify stays readable, with product_deleted or variant_deleted true. unsubscribed_at is this signup's own opt-out; customer_unsubscribed_at is the customer's. An unknown id gives 404 not_found.
Also searched asshow signupget signuplook up waitlist entryview restock signupsignup details
Path parameters
idstringRequiredThe signup's ID, from
GET /back_in_stock/signups.
Returns
The signup object.
Errors
not_foundThe path is valid but nothing with that id exists in this store.
validation_failedThe request failed validation.
Any request can also fail with auth_invalid (401) or rate_limited (429).
Every error has the same shape: see Errors and the list of error codes.
curl "https://app.stoqapp.com/api/v2/external/back_in_stock/signups/string" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/back_in_stock/signups/string", {
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://app.stoqapp.com/api/v2/external/back_in_stock/signups/string",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/back_in_stock/signups/string")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"id": "string",
"channel": "email",
"source": "string",
"contact": "string",
"quantity": 1,
"shopify_product_id": "string",
"shopify_variant_id": "string",
"product_title": "string",
"variant_title": "string",
"sku": "string",
"product_deleted": true,
"variant_deleted": true,
"shopify_market_id": null,
"customer_id": "string",
"customer_name": null,
"accepts_marketing": true,
"customer_unsubscribed_at": null,
"customer_bounce_count": 1,
"optin_confirmed": true,
"unsubscribed_at": null,
"notifications_count": 1,
"notified_at": null,
"created_at": "2026-01-15T09:30:00Z"
}{
"errors": [
"Invalid API key"
],
"code": "auth_invalid",
"details": [
{
"code": "auth_invalid",
"message": "Invalid API key",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"Offer not found"
],
"code": "not_found",
"details": [
{
"code": "not_found",
"message": "Offer not found",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"name is required"
],
"code": "validation_failed",
"details": [
{
"code": "validation_failed",
"message": "name is required",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited",
"details": [
{
"code": "rate_limited",
"message": "Rate limit exceeded",
"path": null,
"value": null,
"expected": null
}
]
}