Talon.One

Talon.One Referrals API

Represents a referral code shared between a customer (advocate) and a prospect (friend). A referral is defined by: - an advocate: person who invited their friend via referral program. - a friend: person who receives the invite from an advocate. - a referral code: code to be redeemed by the advocate(s) once they referred their friend. See the [docs](https://docs.talon.one/docs/product/campaigns/referrals/referral-overview).

GitHub OpenAPI
Business capability
Customer Relationship Management BC-420

Operations 8

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

POST /v1/referrals Create a referral code for an advocate · Create referral code for an advocate #
Ask an LLM
“How do I give one customer a referral code they can share with friends?”
“Can a referral code have a usage limit and an expiry date?”
Tell an agent
Create a referral code for advocate {advocateProfileIntegrationId} in campaign {campaignId}.
Create a referral for advocate {advocateProfileIntegrationId} in campaign {campaignId} that expires on {expiryDate}.
POST /v1/referrals_for_multiple_advocates Create referral codes for many advocates at once · Create referral codes for multiple advocates #
Ask an LLM
“Can I generate unique referral codes for a whole list of customers in one request?”
“How do I control the characters and pattern of bulk-generated referral codes?”
Tell an agent
Create referral codes in campaign {campaignId} for advocates {advocateProfileIntegrationIds}.
Generate codes for advocates {advocateProfileIntegrationIds} in campaign {campaignId} using pattern {referralPattern}.
DELETE /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} Delete a referral · Delete referral #
Ask an LLM
“How do I revoke a referral code that's being abused?”
“Can I delete a single referral from a campaign?”
Tell an agent destructive · confirm first
Delete referral {referralId} from campaign {campaignId} in Application {applicationId}.
Remove referral code {referralId} in campaign {campaignId}, Application {applicationId}.
PUT /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} Update a referral · Update referral #
Ask an LLM
“How do I extend the expiry date of an existing referral code?”
“Can I change the usage limit or assigned friend on a referral after it's created?”
Tell an agent
Set the expiry of referral {referralId} in campaign {campaignId}, Application {applicationId}, to {expiryDate}.
Change referral {referralId}'s usage limit to {usageLimit} in campaign {campaignId} of Application {applicationId}.
GET /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total List a campaign's referrals · List referrals #
Ask an LLM
“Which referral codes exist in a campaign, and which are still usable?”
“Can I list all the referrals one advocate has created?”
Tell an agent
List the referrals in campaign {campaignId} of Application {applicationId}.
Show referrals by advocate {advocate} in campaign {campaignId}, Application {applicationId}.
GET /v1/applications/{applicationId}/profile/{integrationId}/friends List friends a customer has referred · List friends referred by customer profile #
Ask an LLM
“Who has a particular customer successfully referred?”
“How many friends has one advocate brought into my Application?”
Tell an agent
List the friends referred by customer {integrationId} in Application {applicationId}.
Show who advocate {integrationId} referred in Application {applicationId}, with the total count.
GET /v1/applications/{applicationId}/export_referrals Export referrals to CSV · Export referrals #
Ask an LLM
“Can I download all referral codes in an Application as a spreadsheet?”
“How do I export only the valid referrals from one campaign or batch?”
Tell an agent
Export the referrals of Application {applicationId} to CSV.
Download referrals from campaign {campaignId} in Application {applicationId} created after {createdAfter}.
POST /v1/applications/{applicationId}/campaigns/{campaignId}/import_referrals Import referral codes from a CSV file · Import referrals #
Ask an LLM
“How do I bring existing referral codes from another system into a campaign?”
“What columns does a referral import CSV need?”
Tell an agent
Import the referrals in {upFile} into campaign {campaignId} of Application {applicationId}.
Upload referral CSV {upFile} to campaign {campaignId}, Application {applicationId}.

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-referrals-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-referrals-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-referrals-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Talon One Referrals API
  version: ''
  description: 'Operations tagged Referrals 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 (33 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/talon-one/refs/heads/main/openapi/talon-one-referrals-api-openapi.yml