> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Achievement (JSON)
> Achievement (JSON)
# Achievement (JSON)
An Achievement object (version 2).
## Achievement
The Achievement object has the following specification. All members are required.
| Member | Type | Description |
| ----------------- | ---------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id | string | Resource identifier. |
| serviceConfigId | string | SCID for this resource. Identifies the title(s) this achievement is related to. |
| name | string | The localized Achievement name. |
| titleAssociations | array of [TitleAssociation](/reference/live/rest/json/json-titleassociation) | An array of TitleAssociation. |
| progressState | **ProgressState** enumeration | The state of progression: - invalid (0): The achievement progression is in an unknown state.
- achieved (1): The achievement has been unlocked.
- inProgress (2): The achievement is locked but the user has made progress toward unlocking it.
- notStarted (3): The achievement is locked and the user has not made any progress toward unlocking it.
|
| progression | [Progression](/reference/live/rest/json/json-progression) | The user's progression within the achievement. |
| mediaAssets | array of [MediaAsset](/reference/live/rest/json/json-mediaasset) | The media assets associated with the achievement, such as image IDs. |
| platform | string | The platform the achievement was earned on. |
| isSecret | Boolean value | Whether or not the achievement is secret. |
| description | string | The description of the achievement when unlocked. |
| lockedDescription | string | The description of the achievement before it is unlocked. |
| productId | string | The ProductId the achievement was released with. |
| achievementType | **AchievementType** enumeration | The type of achievement (not the same as the previous type on legacy achievements): - invalid (0): An unknown and unsupported achievement type.
- persistent (1): An achievement that has no end-date and can be unlocked at any time.
- challenge (2): An achievement that has a specific time window during which it can be unlocked.
|
| participationType | **ParticipationType** enumeration | The participation type for the achievement. Valid values are Individual or Group. |
| timeWindow | TimeWindow | The time window during which the achievement may be unlocked. Only supported for Challenges. |
| rewards | array of [Reward](/reference/live/rest/json/json-reward) | The collection of rewards earned when unlocked. |
| estimatedTime | TimeSpan | The estimated time the achievement will take to earn. |
| deeplink | string | A deeplink into the title. |
| isRevoked | Boolean value | Whether or not the achievement is revoked by enforcement. |
## Sample JSON syntax
```json theme={null}
{
"id":"3",
"serviceConfigId":"b5dd9daf-0000-0000-0000-000000000000",
"name":"Default NameString for Microsoft Achievements Sample Achievement 3",
"titleAssociations":
[{
"name":"Microsoft Achievements Sample",
"id":3051199919,
"version":"abc"
}],
"progressState":"Achieved",
"progression":
{
"requirements":
[{
"id":"12345678-1234-1234-1234-123456789012",
"current":null,
"target":"100"
}],
"timeUnlocked":"2013-01-17T03:19:00.3087016Z",
},
"mediaAssets":
[{
"name":"Icon Name",
"type":"Icon",
"url":"http://www.xbox.com"
}],
"platform":"D",
"isSecret":true,
"description":"Default DescriptionString for Microsoft Achievements Sample Achievement 3",
"lockedDescription":"Default UnachievedString for Microsoft Achievements Sample Achievement 3",
"productId":"12345678-1234-1234-1234-123456789012",
"achievementType":"Challenge",
"participationType":"Individual",
"timeWindow":
{
"startDate":"2013-02-01T00:00:00Z",
"endDate":"2100-07-01T00:00:00Z"
},
"rewards":
[{
"name":null,
"description":null,
"value":"10",
"type":"Gamerscore",
"valueType":"Int"
},
{
"name":"Default Name for InAppReward for Microsoft Achievements Sample Achievement 3",
"description":"Default Description for InAppReward for Microsoft Achievements Sample Achievement 3",
"value":"1",
"type":"InApp",
"valueType":"String"
}],
"estimatedTime":"06:12:14",
"deeplink":"aWFtYWRlZXBsaW5r",
"isRevoked":false
}
```
## See also
##### Parent
[JavaScript Object Notation (JSON) Object Reference](/reference/live/rest/json/atoc-xboxlivews-reference-json)
## Related topics
- [Achievements](/services/xbox-services/player-data/achievements/index.md)
- [Use the GDK with Unreal Engine](/build/gdk-and-engines/unreal/unreal.md)
- [Uso del GDK con Unreal Engine](/es/build/gdk-and-engines/unreal/unreal.md)
- [在 Unreal Engine 中使用 GDK](/zh-CN/build/gdk-and-engines/unreal/unreal.md)
- [Unreal Engine와 함께 GDK 사용](/ko/build/gdk-and-engines/unreal/unreal.md)