How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Talon.One Achievements API

Represents achievements that reward a customer profile for performing a number of specific actions or reaching a transactional milestone within a defined period.For example, you can use achievements to award your customers when they purchase five cups of coffee in one week or when they purchase items worth $3000 in three months.

Talon.One Achievements API is one of 42 APIs that Talon.One publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Achievements. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and a getting-started guide.

This API exposes 15 operations across 9 paths, and defines 18 schemas. It is described by OpenAPI 3.2.0.

Requests are made against a single base URL, https://yourbaseurl.talon.one.

15 operations 9 paths 18 schemas 2 DELETE9 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://yourbaseurl.talon.one
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Talon.One Achievements API declares 3 security schemes for authenticating requests. An API key is passed in the header as Authorization (api_key_v1). An API key is passed in the header as Authorization (manager_auth). An API key is passed in the header as Authorization (management_key).

  • api_key_v1 — To authenticate with the Integration API, generate an API key in the Campaign Manager and prefix it with ApiKey-v1. To generate an API key: 1. Sign in to the C…
  • manager_auth — This authentication scheme relies on a bearer token that you can use to access all the endpoints of the Management API. To create the token: 1. Get a bearer to…
  • management_key — The API key authentication gives you access to the endpoints selected by the admin who created the key. Using an API key is the recommended authentication meth…

Paths & Operations 15

Across 9 paths, the API surfaces 15 operations — 2 DELETE, 9 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Achievements 15

Represents achievements that reward a customer profile for performing a number of specific actions or reaching a transactional milestone within a defined period. For example, you…

GET
/v1/customer_profiles/{integrationId}/achievements
List customer's available achievements
getCustomerAchievements 7 params → 200400401404
GET
/v1/customer_profiles/{integrationId}/achievements/{achievementId}
List customer's achievement history
getCustomerAchievementHistory 7 params → 200400401404
POST
/v1/applications/{applicationId}/campaigns/{campaignId}/achievementsdeprecated
Create achievement
createAchievement 2 params body → 201400401409
GET
/v1/applications/{applicationId}/campaigns/{campaignId}/achievementsdeprecated
List achievements
listAchievements 5 params → 200
GET
/v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}deprecated
Get achievement
getAchievement 3 params → 200401404
PUT
/v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}deprecated
Update achievement
updateAchievement 3 params body → 200400401404
DELETE
/v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}deprecated
Delete achievement
deleteAchievement 3 params → 204401404
GET
/v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}/exportdeprecated
Export achievement customer data
exportAchievements 3 params → 200400401404
GET
/v2/achievements
List achievements
listAchievementsV2 5 params → 200400401
POST
/v2/achievements
Create achievement
createAchievementV2 body → 201400401409
GET
/v2/achievements/{achievementId}
Get achievement
getAchievementV2 1 param → 200401404
PUT
/v2/achievements/{achievementId}
Update achievement
updateAchievementV2 1 param body → 200400401404
DELETE
/v2/achievements/{achievementId}
Delete achievement
deleteAchievementV2 1 param → 204401404
GET
/v2/achievements/{achievementId}/export
Export achievement customer data
exportAchievementV2 1 param → 200400401404
GET
/v1/applications/{applicationId}/achievement_progress/{integrationId}
List customer achievements
getCustomerProfileAchievementProgress 6 params → 200400401

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are AchievementBaseV2 (11 properties), AchievementBase (11 properties), TimePoint (6 properties), AchievementProgress (5 properties). Each schema is shown below with its type and property counts.

AchievementStatusEntry
ErrorResponseWithStatus
object
3 properties
APIError
object
3 properties 2 required
AchievementProgress
object
The current progress of the customer in the achievement.
5 properties 2 required
AchievementBase
object
11 properties
Entity
object
2 properties 2 required
ErrorSource
object
The source of the current error, exactly one of pointer, parameter or line will be defined.
4 properties
CreateAchievement
TimePoint
object
The absolute duration after which the achievement ends and resets for a particular customer profile. Note: The duration follows the time zone of the Applicatio…
6 properties 3 required
AchievementAdditionalPropertiesV2
object
5 properties 1 required
AchievementProgressWithDefinition
UpdateAchievementV2
CreateAchievementV2
AchievementV2
AchievementAdditionalProperties
object
5 properties 2 required
AchievementBaseV2
object
11 properties
Achievement
UpdateAchievement

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

talon-one-achievements-api-openapi.yml Raw ↑

Other APIs Talon.One publishes across the network.

Talon.One Accounts and users API
Talon.One Additional costs API
Talon.One Analytics API
Talon.One Applications API
Talon.One Attributes API
Talon.One Audiences API
Talon.One Braze API
Talon.One Campaign access groups API
Talon.One Campaign notifications API
Talon.One Campaign templates API
Talon.One Campaigns API
Talon.One Catalogs API
Where this information came from

This is an independent, third-party profile of Talon.One Achievements API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.