--- title: "Get achievement" method: GET path: "/v2/achievements/{achievementId}" tags: ["Achievements"] --- # Get achievement `GET /v2/achievements/{achievementId}` ## Request - Base URL: `https://yourbaseurl.talon.one` - URL: `https://yourbaseurl.talon.one/v2/achievements/{achievementId}` - Auth: one of: - API key in header `Authorization` - API key in header `Authorization` - TypeScript: (a function with typed inputs; its response is checked against the schema) > [!note] Management API endpoints are **not** meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second. Retrieve the details of a specific achievement. ## Path parameters - `achievementId` integer, required ## Response `200` OK - AchievementV2 - `id` integer, required: The internal ID of this entity. - `created` string, date-time, required: The time this entity was created. - `name` string, required: The internal name of the achievement used in API requests. **Note**: The name should start with a letter. This cannot be changed after the achievement has been created. - `title` string, required: The display name for the achievement in the Campaign Manager. - `description` string, string, required: A description of the achievement. - `target` number, required: The required number of actions or the transactional milestone to complete the achievement. - `period` string: The relative duration after which the achievement ends and resets for a particular customer profile. **Note**: The `period` does not start when the achievement is created. The period is a **positive real number** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` **Note**: You can either use the round down and round up option or set an absolute period. - `recurrencePolicy` 'no_recurrence' | 'on_expiration' | 'on_completion', required: The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again. - `activationPolicy` 'user_action' | 'fixed_schedule', required: The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. - `fixedStartDate` string, date-time: The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. - `endDate` string, date-time: The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. - `allowRollbackAfterCompletion` boolean: When `true`, customer progress can be rolled back in completed achievements. - `subscribedApplications` integer[], required: A list containing the IDs of all applications that are subscribed to A list containing the IDs of all Applications that are connected to this achievement. - `userId` integer, required: The ID of the user that created this achievement. - `createdBy` string: Name of the user that created the achievement. **Note**: This is not available if the user has been deleted. - `periodEndOverride` TimePoint: The absolute duration after which the achievement ends and resets for a particular customer profile. **Note**: The duration follows the time zone of the Application this achievement belongs to. - `month` integer: The achievement ends and resets in this month. **Note**: Only applicable if the period is set to `Y`. - `dayOfMonth` integer: The achievement ends and resets on this day of the month. **Note**: Only applicable if the period is set to `Y` or `M`. - `dayOfWeek` integer: The achievement ends and resets on this day of the week. `1` represents `Monday` and `7` represents `Sunday`. **Note**: Only applicable if the period is set to `W`. - `hour` integer, required: The achievement ends and resets at this hour. - `minute` integer, required: The achievement ends and resets at this minute. - `second` integer, required: The achievement ends and resets at this second. - `hasProgress` boolean: Indicates if a customer has made progress in the achievement. - `status` 'active' | 'scheduled' | 'expired': The status of the achievement. - `active`: The achievement is available to customers. - `scheduled`: The achievement has a `fixedStartDate` set in the future. - `expired`: The achievement's `endDate` is in the past. - `sandbox` boolean, required: Indicates if this achievement is a live or sandbox achievement. Achievements of a given type can only be connected to Applications of the same type. - `timezone` string, required: A string containing an IANA timezone descriptor. - `campaignId` integer: This property is **deprecated**. Use `referencedByCampaigns` instead. This field contains the first campaign ID from the related `referencedByCampaigns`, and is omitted when `referencedByCampaigns` is empty. - `referencedByCampaigns` CampaignReference[], required: The campaigns that reference this achievement. They are sorted in ascending order by their id. - `id` integer, required: The ID of the campaign that references this achievement. - `applicationId` integer, required: The ID of the Application the campaign belongs to. ## Other responses - `401`: Unauthorized - `404`: Not found ## Changes - **2026-11-07** `7ef1b9504c3a`: 1 info - endpoint added [Operation history](https://skmtc.dev/talon/apis/management-api/changes/v2/achievements/:achievementId/get.md) --- [API](https://skmtc.dev/talon/apis/management-api.md) - [All operations](https://skmtc.dev/talon/apis/management-api/llms.txt) - [OpenAPI document](https://skmtc.dev/talon/apis/management-api/revisions/7ef1b9504c3a?raw)