Talon.One

Talon.One Campaigns API

Represents the primary resource used to control the behavior of the Talon.One Rule Engine. They combine rulesets, coupons, and limits into a single unit. See the [docs](https://docs.talon.one/docs/product/campaigns/overview).

GitHub OpenAPI
Business capability
Discount & Promotion Management BC-440.30

Operations 12

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/integration/campaigns List running campaigns for an integration · List all running campaigns #
Ask an LLM
“Which promotions are live right now that my storefront should know about?”
“Can my integration list running campaigns for a specific store or audience?”
Tell an agent
List the campaigns currently running for my integration.
Show running campaigns for store {storeId} that start after {startAfter}.
GET /v1/applications/{applicationId}/campaigns List campaigns in an Application · List campaigns #
Ask an LLM
“What campaigns does my Application have, including disabled and expired ones?”
“Can I filter campaigns by tag, state, or the template they came from?”
Tell an agent
List the campaigns in Application {applicationId}.
Show {campaignState} campaigns in Application {applicationId} tagged {tags}.
GET /v1/applications/{applicationId}/campaigns/{campaignId} Get a campaign · Get campaign #
Ask an LLM
“What are the settings, dates and limits of a particular campaign?”
“Can I fetch one campaign's configuration by its ID?”
Tell an agent
Get campaign {campaignId} in Application {applicationId}.
Show the configuration of campaign {campaignId} from Application {applicationId}.
PUT /v1/applications/{applicationId}/campaigns/{campaignId} Update a campaign · Update campaign #
Ask an LLM
“How do I change a campaign's end date or disable it?”
“Can I edit a campaign when campaign staging and revisions is turned on?”
Tell an agent
Set campaign {campaignId} in Application {applicationId} to state {state}.
Change the end time of campaign {campaignId} in Application {applicationId} to {endTime}.
DELETE /v1/applications/{applicationId}/campaigns/{campaignId} Delete a campaign · Delete campaign #
Ask an LLM
“How do I permanently delete a campaign I no longer need?”
“Can I remove a test campaign from an Application?”
Tell an agent destructive · confirm first
Delete campaign {campaignId} from Application {applicationId}.
Permanently remove campaign {campaignId} in Application {applicationId}.
POST /v1/applications/{applicationId}/campaigns/{campaignId}/copy Copy a campaign into other Applications · Copy the campaign into the specified Application #
Ask an LLM
“How do I reuse the same campaign in another Application or region?”
“Can I rename a campaign or change its dates when copying it?”
Tell an agent
Copy campaign {campaignId} from Application {applicationId} into Applications {applicationIds}.
Duplicate campaign {campaignId} of Application {applicationId} into {applicationIds} under the name {name}.
POST /v1/applications/{applicationId}/campaigns_search Search campaigns by custom attributes · List campaigns that match the given attributes #
Ask an LLM
“Which campaigns have a specific custom attribute value, like a region or budget owner?”
“Can I search only enabled campaigns by their attributes?”
Tell an agent
Find campaigns in Application {applicationId} matching attributes {attributes}.
Search {campaignState} campaigns in Application {applicationId} with attributes {attributes}.
GET /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets List a campaign's ruleset revisions · List campaign rulesets #
Ask an LLM
“What revisions have a campaign's rules gone through?”
“Why does the rulesets list include deleted rules?”
Tell an agent
List all ruleset revisions of campaign {campaignId} in Application {applicationId}.
Show the rule history for campaign {campaignId}, Application {applicationId}.
GET /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} Get a campaign ruleset (v1) · Get ruleset #
Ask an LLM
“What rules does one specific ruleset revision contain, using the original v1 endpoint?”
“Can I fetch a single ruleset by ID through the older version of the API?”
Tell an agent
Get ruleset {rulesetId} of campaign {campaignId} in Application {applicationId} using the v1 endpoint.
Show v1 ruleset {rulesetId} for campaign {campaignId}, Application {applicationId}.
GET /v2/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} Get a campaign ruleset as JSON (v2) · Get ruleset (V2) #
Ask an LLM
“Can I get a campaign's ruleset as a plain JSON object from the v2 endpoint?”
“Which ruleset endpoint returns the rules in the newer v2 JSON format?”
Tell an agent
Get ruleset {rulesetId} of campaign {campaignId} in Application {applicationId} as v2 JSON.
Fetch the v2 JSON of ruleset {rulesetId} for campaign {campaignId}, Application {applicationId}.
GET /v1/applications/{applicationId}/campaigns/{campaignId}/analytics Get a campaign's performance analytics · Get analytics of campaigns #
Ask an LLM
“How did one campaign perform last month in revenue and discounts given?”
“Can I see a campaign's analytics broken down by day?”
Tell an agent
Get analytics for campaign {campaignId} in Application {applicationId} from {rangeStart} to {rangeEnd}.
Show campaign {campaignId}'s performance in Application {applicationId} between {rangeStart} and {rangeEnd} at {granularity} granularity.
GET /v1/applications/{applicationId}/campaign_analytics/export Export campaign analytics for an Application to CSV · Export Application analytics aggregated by campaign #
Ask an LLM
“Can I download a spreadsheet comparing all campaigns' results in an Application?”
“How do I export analytics for only a few selected campaigns?”
Tell an agent
Export per-campaign analytics for Application {applicationId} from {rangeStart} to {rangeEnd}.
Download a CSV of analytics for campaigns {campaignIds} in Application {applicationId} between {rangeStart} and {rangeEnd}.

Documentation

📖
APIReference
https://docs.talon.one/integration-api
📖
Documentation
https://docs.talon.one/docs/dev/integration-api/overview
📖
GettingStarted
https://docs.talon.one/docs/dev/quickstart
📖
APIReference
https://docs.talon.one/management-api
📖
Documentation
https://docs.talon.one/docs/dev/management-api/overview
📖
APIReference
https://docs.talon.one/third-party-api
📖
Documentation
https://docs.talon.one/docs/dev/technology-partners/overview
📖
Documentation
https://docs.talon.one/docs/dev/technology-partners/shopify/integrate-with-shopify
📖
Documentation
https://docs.talon.one/docs/dev/get-started/webhooks
📖
APIReference
https://docs.talon.one/outbound-notifications

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/talon-one/refs/heads/main/openapi/talon-one-campaigns-api-openapi.yml

Other Resources

🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/talon-one/refs/heads/main/collections/talon-one.postman_collection.json
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/talon-one/refs/heads/main/collections/talon-one.opencollection.json
🔗
Postman
https://www.postman.com/talonone-rnd/workspace/talon-one/overview
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/talon-one/refs/heads/main/data-model/talon-one-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/talon-one/refs/heads/main/asyncapi/talon-one-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/talon-one:talon-one-campaigns-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

talon-one-campaigns-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Talon One Campaigns API
  version: ''
  description: 'Operations tagged Campaigns across 2 of this provider''s published API definitions: talon-one-integration-api-openapi.yml, talon-one-management-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://yourbaseurl.talon.one
tags:


# --- truncated at 32 KB (143 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/talon-one/refs/heads/main/openapi/talon-one-campaigns-api-openapi.yml