curl --request GET \
--url http://localhost/api/v3/achievements/definitions{
"data": [
{
"id": 123,
"name": "<string>",
"handle": "<string>",
"region_id": 123,
"region": {
"id": 123,
"name": "<string>",
"handle": "<string>"
},
"currency": "<string>",
"description": "<string>",
"internal_notes": "<string>",
"type": "<string>",
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"is_published": true,
"display_level": true,
"display_option": "<string>",
"short_description": "<string>",
"long_description": "<string>",
"terms_conditions": "<string>",
"earn_instructions": "<string>",
"icon": "<string>",
"image_url": "<string>",
"levels": [
{
"id": 123,
"name": "<string>",
"achievement_definition_id": 123,
"display_number": 123,
"description": "<string>",
"trigger": 123,
"repeats": true,
"repeat_interval": 123,
"allow_multiple_earn": true,
"computed_display_number": "<string>",
"computed_trigger": "<string>",
"meta": [
"<unknown>"
]
}
],
"tags": [
"<string>"
],
"meta": [
"<unknown>"
],
"timezone": "<string>",
"period": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"enable_annual_earn_cycle": true
}
]
}A GET to the /achievements/definitions endpoint allows your application to retrieve all a tenants Achievement Definitions.
curl --request GET \
--url http://localhost/api/v3/achievements/definitions{
"data": [
{
"id": 123,
"name": "<string>",
"handle": "<string>",
"region_id": 123,
"region": {
"id": 123,
"name": "<string>",
"handle": "<string>"
},
"currency": "<string>",
"description": "<string>",
"internal_notes": "<string>",
"type": "<string>",
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"is_published": true,
"display_level": true,
"display_option": "<string>",
"short_description": "<string>",
"long_description": "<string>",
"terms_conditions": "<string>",
"earn_instructions": "<string>",
"icon": "<string>",
"image_url": "<string>",
"levels": [
{
"id": 123,
"name": "<string>",
"achievement_definition_id": 123,
"display_number": 123,
"description": "<string>",
"trigger": 123,
"repeats": true,
"repeat_interval": 123,
"allow_multiple_earn": true,
"computed_display_number": "<string>",
"computed_trigger": "<string>",
"meta": [
"<unknown>"
]
}
],
"tags": [
"<string>"
],
"meta": [
"<unknown>"
],
"timezone": "<string>",
"period": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"enable_annual_earn_cycle": true
}
]
}Documentation Index
Fetch the complete documentation index at: https://docs.omneo.io/llms.txt
Use this file to discover all available pages before exploring further.