List and filter Intents

List and filter intents

get

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Query parameters

shopify_variant_idintegerOptional

Filter by Shopify Variant ID

shopify_product_idintegerOptional

Filter by Shopify Product ID

emailstringOptional

Filter by customer email

phonestringOptional

Filter by customer phone

start_datestring · dateOptional

Filter by start date (YYYY-MM-DD)

end_datestring · dateOptional

Filter by end date (YYYY-MM-DD)

notifiedbooleanOptional

Filter by notification status (true = notified, false = not notified)

pageintegerOptional

Page number for pagination

per_pageintegerOptional

Number of items per page (maximum 500)

Header parameters

X-Auth-TokenstringRequired

API key for authentication

Responses

200

A paginated list of intents

application/json

400

Bad request

401

Unauthorized

get

/intents

HTTPcURLJavaScriptPython

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

{
  "intents": [
    {
      "id": "text",
      "blocked_at": "2026-01-15T04:02:12.406Z",
      "channel": "text",
      "email": "text",
      "notified_at": "2026-01-15T04:02:12.406Z",
      "optin_confirmed": true,
      "phone": "text",
      "quantity": 1,
      "sent_notifications_count": 1,
      "source": "text",
      "type": "text",
      "unsubscribed_at": "2026-01-15T04:02:12.406Z",
      "created_at": "2026-01-15T04:02:12.406Z",
      "updated_at": "2026-01-15T04:02:12.406Z",
      "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-01-15T04:02:12.406Z",
      "accepts_marketing": true,
      "notifications_count": 1
    }
  ],
  "meta": {
    "total_count": 1,
    "page": 1,
    "per_page": 1,
    "total_pages": 1
  }
}