Skip to main content
GET
/
v3
/
rewards
/
definitions
/
{definition}
Read Reward Definition
curl --request GET \
  --url http://localhost/api/v3/rewards/definitions/{definition}
{
  "data": {
    "id": 123,
    "name": "<string>",
    "handle": "<string>",
    "region_id": 123,
    "region": {
      "id": 123,
      "name": "<string>",
      "handle": "<string>"
    },
    "currency": "<string>",
    "period": 123,
    "period_type": "<string>",
    "absolute_expiry": "<string>",
    "description": "<string>",
    "short_description": "<string>",
    "long_description": "<string>",
    "terms_conditions": "<string>",
    "earn_instructions": "<string>",
    "icon": "<string>",
    "image_url": "<string>",
    "issue_target_id": 123,
    "expiry_target_id": 123,
    "extend_target_id": 123,
    "notify_issue_offset": 123,
    "notify_expiry_offset": 123,
    "notify_schedule_offset": 123,
    "notify_issue_offset_days": 123,
    "notify_issue_offset_hour": 123,
    "notify_remind_offset_days": 123,
    "notify_remind_offset_hour": 123,
    "notify_extend_offset_days": 123,
    "notify_extend_offset_hour": 123,
    "internal_notes": "<string>",
    "type": "<string>",
    "value": 123,
    "max_value": 123,
    "is_extendable": true,
    "is_assignable": true,
    "is_reassignable": true,
    "is_published": true,
    "extend_days": 123,
    "tags": [
      "<string>"
    ],
    "created_at": "<string>",
    "updated_at": "<string>"
  }
}

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.

Path Parameters

definition
integer
required

The definition ID

Response

RewardDefinition

data
RewardDefinition · object
required