The CueCode APIs enable secure, programmatic interaction between CueCode and client systems for the purpose of loading data, refreshing cues, and retrieving and responding to cues.
\nAll requests must include a valid API Key. Send the key in the Authorization header using the ApiKey prefix:
Authorization: ApiKey {your-api-key}
API Keys are generated and managed within the CueCode Ops Platform.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"38228799","collectionId":"08b2345f-2ed6-4ce6-87b0-6c51b4b4b2b6","publishedId":"2sB3WttK4u","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-11-11T16:59:59.000Z"},"item":[{"name":"Refresh","item":[{"name":"LoadFile","id":"d24cacdd-ecc0-480e-ad27-4eb36b88e8d9","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"ApiKey {your-api-key}","type":"text"},{"key":"FileName","value":"{FileName}.csv","type":"text"},{"key":"Content-Type","value":"text/csv","type":"text"}],"body":{"mode":"file","file":{"src":"/G:/My Drive/Demo Data/Mini Food Demo/Customers.csv"}},"url":"https://app.cuecode.io/ops/rest/v1/LoadFile?TargetEntity={TargetEntity}&IsReplace=true&BatchId={BatchId}","description":"Loads a CSV file to the specified entity. Send the CSV as the request body and specify the file name in the header.
\nCustomers
Products
ProductDivisionAvailability
Transactions
OpenOrders
Quotes
Contracts
202 Load started successfully
403 Missing API role permissions
422 Invalid Target Entity
Target entity for the data load.
\n","type":"text/plain"},"key":"TargetEntity","value":"{TargetEntity}"},{"description":{"content":"Boolean parameter specifying if the data load should replace all data in the target entity (true), or function as an upsert (false).
\n","type":"text/plain"},"key":"IsReplace","value":"true"},{"description":{"content":"Optional, consumer-defined identifier for a batch of LoadFile requests.
\n","type":"text/plain"},"key":"BatchId","value":"{BatchId}"}],"variable":[]}},"response":[],"_postman_id":"d24cacdd-ecc0-480e-ad27-4eb36b88e8d9"},{"name":"BatchStatus","id":"3034c2ce-32af-472b-a419-2742d1e201b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"ApiKey {your-api-key}","type":"text"}],"url":"https://app.cuecode.io/ops/rest/v1/BatchStatus?BatchId={BatchId}","description":"Request the status of a batch of LoadFile requests.
\n200 Successful retrieval
403 Missing API role permissions
404 Invalid BatchId
Consumer-defined identifier for a batch of LoadFile requests.
\n","type":"text/plain"},"key":"BatchId","value":"{BatchId}"}],"variable":[]}},"response":[{"id":"453540fb-45d3-40e8-b2ea-5f39d2c5a192","name":"Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.cuecode.io/ops/rest/v1/BatchStatus?BatchId=batch001","protocol":"https","host":["app","cuecode","io"],"path":["ops","rest","v1","BatchStatus"],"query":[{"key":"BatchId","value":"batch001"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"complete\": true\n}"}],"_postman_id":"3034c2ce-32af-472b-a419-2742d1e201b6"},{"name":"Refresh","id":"d12250a8-a391-4742-97ba-17554de218c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"ApiKey {your-api-key}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://app.cuecode.io/ops/rest/v1/Refresh?Type={RefreshType}","description":"Starts a designated refresh job.
\nFull A full refresh of all classifications and predictions, regenerating candidate cues to be available for the next run of a trigger. Also updates realized metrics for consumed cues. Designed to run weekly.
Full_Trigger Full refresh that also runs and publishes triggers set to autopilot.
Lite The lite refresh recalculates routine reorder cues and removes any candidate cues no longer relevant based on the latest transaction and open order data. Designed to run daily.
Lite_Trigger Lite refresh that also runs and publishes triggers set to autopilot.
202 Refresh job started successfully
403 Missing API role permissions
422 Invalid refresh Type
Specifies the type of refresh.
\n","type":"text/plain"},"key":"Type","value":"{RefreshType}"}],"variable":[]}},"response":[],"_postman_id":"d12250a8-a391-4742-97ba-17554de218c9"}],"id":"0069d68c-9cd6-4149-b591-8505af5fdd52","description":"Requests for loading data and refreshing cues.
\nThe expected pattern for refreshing data and cues is as follows:
\nMake multiple LoadFile requests referencing a single, consumer-defined BatchId.
\nPoll BatchStatus using the BatchId to check the progress of the data loads.
\nOnce BatchStatus returns \"Complete\": true, make a Refresh request of the desired type.
Retrieve all active published cues for a given customer.
\n200 Successful retrieval
403 Missing API role permissions
Optional parameter to filter results to a single customer.
\n","type":"text/plain"},"key":"CustomerId","value":"{CustomerId}"},{"description":{"content":"Optional, boolean parameter to include recently consumed cues in the response (true), or only include active cues (false). Defaults to false when not included.
\n","type":"text/plain"},"key":"IncludeVisibleConsumed","value":"true"}],"variable":[]}},"response":[{"id":"68c78148-6909-4d2a-b276-10968e20b594","name":"Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.cuecode.io/ops/rest/v1/ActiveCues?CustomerId=00123&IncludeVisibleConsumed=true","protocol":"https","host":["app","cuecode","io"],"path":["ops","rest","v1","ActiveCues"],"query":[{"key":"CustomerId","value":"00123","description":"Customer unique identifier."},{"key":"IncludeVisibleConsumed","value":"true","description":"Boolean parameter managing the inclusion of recently consumed cues in the response."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"cueId\": 1,\n \"triggerId\": 1,\n \"triggerLabel\": \"Weekly Reorder Alerts\",\n \"type\": \"Reorder\",\n \"customerLevel\": \"Ship-to\",\n \"customerId\": \"00123\",\n \"productId\": \"A03-WIDG\",\n \"productDescription\": \"Classic Widgets, green\",\n \"recordId\": \"0\",\n \"score\": 0.808153,\n \"predictedVolume\": 280.10,\n \"variant\": \"Periodic\",\n \"context\": \"Typically ordered every 4 weeks. Last purchased 7 weeks ago the week of 8 Sep 2025.\",\n \"lastTransactionDate\": \"2025-09-13\",\n \"lastTransactionPrice\": 140.05,\n \"lastTransactionMargin\": 0.285,\n \"targetMargin\": 0.305,\n \"priority\": 1,\n \"script\": \"\",\n \"startDate\": \"1900-01-01\",\n \"expirationDate\": \"1900-01-01\",\n \"publishedDate\": \"2025-11-06T20:07:18Z\",\n \"updatedDate\": \"2025-11-07T16:05:29Z\",\n \"isActive\": true,\n \"isConsumed\": false,\n \"consumedDate\": \"1900-01-01T00:00:00\",\n \"response\": \"\",\n \"comment\": \"\",\n \"responseDate\": \"1900-01-01T00:00:00\"\n },\n {\n \"id\": 104,\n \"triggerId\": 4,\n \"triggerLabel\": \"Quote Reminders\",\n \"type\": \"Quote Follow-up\",\n \"customerLevel\": \"Ship-to\",\n \"customerId\": \"00123\",\n \"productId\": \"C42-RIZ\",\n \"productDescription\": \"Riz 42 Autotron\",\n \"recordId\": \"QT-02\",\n \"score\": 0.6841,\n \"predictedVolume\": 250,\n \"variant\": \"New Product\",\n \"context\": \"New product quoted 10 at 25.00 on 25 Oct 2025.\",\n \"lastTransactionDate\": \"1900-01-01\",\n \"lastTransactionPrice\": 0.0,\n \"lastTransactionMargin\": 0.0,\n \"targetMargin\": 0.26,\n \"priority\": 1,\n \"script\": \"\",\n \"startDate\": \"1900-01-01\",\n \"expirationDate\": \"1900-01-01\",\n \"publishedDate\": \"2025-11-06T20:07:18Z\",\n \"updatedDate\": \"2025-11-06T20:07:18Z\",\n \"isActive\": true,\n \"isConsumed\": false,\n \"consumedDate\": \"1900-01-01T00:00:00\",\n \"response\": \"\",\n \"comment\": \"\",\n \"responseDate\": \"1900-01-01T00:00:00\"\n }\n]"}],"_postman_id":"169abfae-71a6-48f3-961a-7a1046b869f6"},{"name":"CueResponse","id":"c6d1d571-1fa8-4bfc-b433-9d0fac1d8d96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"ApiKey {your-api-key}","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"cueId\": 2350,\r\n \"response\": \"\",\r\n \"comment\": \"\"\r\n },\r\n {\r\n \"cueId\": 2350,\r\n \"response\": \"Won\",\r\n \"comment\": \"Got the order!\"\r\n },\r\n {\r\n \"cueId\": 2351,\r\n \"response\": \"Dismiss\",\r\n \"comment\": \"\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://app.cuecode.io/ops/rest/v1/CueResponse","description":"Consume and respond to a given cue.
\nOptionally provide a response text and/or comment in the request body. Any response text should align with the responses configured in the CueCode Ops Platform.
\nThe first reponse to a cue changes its status to consumed and sets the consumed date.
\n200 Responses processed successfully
403 Missing API role permissions
Requests for retrieving and responding to active cues.
\n","_postman_id":"f8c240cb-44db-4fe5-8314-acad4e8a3229"},{"name":"CompanionProducts","item":[{"name":"CompanionProducts","id":"9a1a719b-09e6-446c-a2d9-0893032ff035","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"ApiKey {your-api-key}","type":"text"}],"url":"https://app.cuecode.io/ops/rest/v1/CompanionProducts?ProductId={ProductId}","urlObject":{"protocol":"https","path":["ops","rest","v1","CompanionProducts"],"host":["app","cuecode","io"],"query":[{"description":{"content":"Lead ProductId for which companion products are requested.
\n","type":"text/plain"},"key":"ProductId","value":"{ProductId}"}],"variable":[]}},"response":[{"id":"85b686a3-9dc2-4e51-9895-261edc239fbf","name":"Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.cuecode.io/ops/rest/v1/CompanionProducts?ProductId=LeadProduct-01","protocol":"https","host":["app","cuecode","io"],"path":["ops","rest","v1","CompanionProducts"],"query":[{"key":"ProductId","value":"LeadProduct-01"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"productId\": \"CompanionProduct-01\",\n \"order\": 1\n },\n {\n \"productId\": \"CompanionProduct-02\",\n \"order\": 2\n },\n {\n \"productId\": \"CompanionProduct-03\",\n \"order\": 3\n }\n]"}],"_postman_id":"9a1a719b-09e6-446c-a2d9-0893032ff035"}],"id":"64dbbe69-d11a-44d6-a838-811f4cbdfbf2","description":"Request to retrieve the configured companion products for a given lead product.
\n","_postman_id":"64dbbe69-d11a-44d6-a838-811f4cbdfbf2"}]}