Get a specific Intent

Get a specific intent

get

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Path parameters

idstringRequired

Intent ID

Header parameters

X-Auth-TokenstringRequired

API key for authentication

Responses

200

Intent details

application/json

idstringOptional

Unique identifier for the intent

blocked_atstring · date-time · nullableOptional

Timestamp when the intent was blocked from sending

channelstringOptional

Communication channel used for notifications (e.g., Email, SMS)

emailstringOptional

Customer's email address for notifications

notified_atstring · date-time · nullableOptional

Timestamp of the notification sent

optin_confirmedbooleanOptional

Whether the customer has confirmed their GDPR opt-in for notifications

phonestringOptional

Customer's phone number for SMS notifications

quantityintegerOptional

Requested quantity of the product when back in stock

sent_notifications_countintegerOptional

Number of notifications sent for this intent

sourcestringOptional

typestringOptional

Type of the intent (e.g., restock, wishlist_reminder)

unsubscribed_atstring · date-time · nullableOptional

Timestamp when the customer unsubscribed from notifications

created_atstring · date-timeOptional

Timestamp when the intent was created

updated_atstring · date-timeOptional

Timestamp when the intent was last updated

customer_idstringOptional

Unique identifier for the customer

intent_trigger_idstring · nullableOptional

Identifier for the trigger that created this intent

product_variant_idstring · nullableOptional

Internal product variant identifier

shop_idstringOptional

Unique identifier for the shop

shopify_inventory_item_idinteger · nullableOptional

Shopify's inventory item identifier

shopify_market_idinteger · nullableOptional

Shopify's market identifier for multi-market stores

shopify_product_idinteger · nullableOptional

Shopify's product identifier

shopify_variant_idinteger · nullableOptional

Shopify's variant identifier

customer_namestring · nullableOptional

Customer's full name

contactstring · nullableOptional

Customer's contact information

customer_unsubscribed_atstring · date-time · nullableOptional

Timestamp when the customer unsubscribed from all notifications

accepts_marketingboolean · nullableOptional

Whether the customer has opted in to receive marketing communications

notifications_countinteger · nullableOptional

Total number of notifications sent for this intent

401

Unauthorized

404

Intent not found

get

/intents/{id}

HTTPcURLJavaScriptPython

GET /api/v1/external/intents/{id} HTTP/1.1
Host: app.stoqapp.com
X-Auth-Token: text
Accept: */*

{
  "id": "text",
  "blocked_at": "2026-02-27T17:13:35.682Z",
  "channel": "text",
  "email": "text",
  "notified_at": "2026-02-27T17:13:35.682Z",
  "optin_confirmed": true,
  "phone": "text",
  "quantity": 1,
  "sent_notifications_count": 1,
  "source": "text",
  "type": "text",
  "unsubscribed_at": "2026-02-27T17:13:35.682Z",
  "created_at": "2026-02-27T17:13:35.682Z",
  "updated_at": "2026-02-27T17:13:35.682Z",
  "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": "2026-02-27T17:13:35.682Z",
  "accepts_marketing": true,
  "notifications_count": 1
}