Get a specific intent

API v1 is the older API. It still works, but new integrations should use API v2. Migrating from v1 to v2

GET/external/intents/{id}

Costs 1 rate-limit point · Rate limits

Retrieve a single back-in-stock intent (signup) by its STOQ ID. Returns the full intent record: the customer contact details, channel, requested quantity, and notification status. Returns 404 if no intent with that ID exists for the authenticated shop.

Path parameters

idstringRequired
Intent ID

Headers

X-Auth-TokenstringRequired
API key for authentication

Returns

The back in stock object.

Errors

401

Unauthorized

404

Intent not found

GET/external/intents/{id}

curl "https://app.stoqapp.com/api/v1/external/intents/8f3c2b1a-7d4e-4c2a-9f10-2b3c4d5e6f70" \
  -H "X-Auth-Token: $STOQ_API_KEY"

const res = await fetch("https://app.stoqapp.com/api/v1/external/intents/8f3c2b1a-7d4e-4c2a-9f10-2b3c4d5e6f70", {
  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/v1/external/intents/8f3c2b1a-7d4e-4c2a-9f10-2b3c4d5e6f70",
    headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
)
data = res.json()

require "net/http"
require "json"

uri = URI("https://app.stoqapp.com/api/v1/external/intents/8f3c2b1a-7d4e-4c2a-9f10-2b3c4d5e6f70")
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)

Response

{
  "id": "8f3c2b1a-7d4e-4c2a-9f10-2b3c4d5e6f70",
  "channel": "email",
  "email": "shopper@example.com",
  "phone": null,
  "quantity": 1,
  "notified_at": null,
  "optin_confirmed": true,
  "source": "api",
  "type": "restock",
  "sent_notifications_count": 0,
  "created_at": "2026-06-20T14:30:00Z",
  "updated_at": "2026-06-20T14:30:00Z",
  "customer_id": "c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
  "shop_id": "a1b2c3d4-5e6f-7081-92a3-b4c5d6e7f809",
  "shopify_product_id": 7891234567890,
  "shopify_variant_id": 43900910010503,
  "accepts_marketing": true
}