STOQ - Developer Documentation
  • Getting Your STOQ API Key
  • Back in Stock API
    • List and filter Intents
    • Get a specific Intent
    • Notify a single Intent
    • Notify multiple intents in bulk
  • JavaScript API
  • Preorder Metafields
    • Shop Level Metafields
    • Product Variant Level Metafields
Powered by GitBook
On this page
Export as PDF
  1. Back in Stock API

Get a specific Intent

PreviousList and filter IntentsNextNotify a single Intent

Last updated 26 days ago

Get a specific intent

get
Authorizations
Path parameters
idstringRequired

Intent ID

Header parameters
X-Auth-TokenstringRequired

API key for authentication

Responses
200
Intent details
application/json
401
Unauthorized
404
Intent not found
get
GET /api/v1/external/intents/{id} HTTP/1.1
Host: app.stoqapp.com
X-Auth-Token: text
Accept: */*
{
  "id": "text",
  "blocked_at": "2025-06-03T02:25:40.338Z",
  "channel": "text",
  "email": "text",
  "notified_at": "2025-06-03T02:25:40.338Z",
  "optin_confirmed": true,
  "phone": "text",
  "quantity": 1,
  "sent_notifications_count": 1,
  "source": "text",
  "type": "text",
  "unsubscribed_at": "2025-06-03T02:25:40.338Z",
  "created_at": "2025-06-03T02:25:40.338Z",
  "updated_at": "2025-06-03T02:25:40.338Z",
  "customer_id": "text",
  "intent_trigger_id": "text",
  "product_variant_id": "text",
  "shop_id": "text",
  "shopify_inventory_item_id": 1,
  "shopify_market_id": 1,
  "shopify_product_id": 1,
  "shopify_variant_id": 1,
  "customer_name": "text",
  "contact": "text",
  "customer_unsubscribed_at": "2025-06-03T02:25:40.338Z",
  "accepts_marketing": true,
  "notifications_count": 1
}