Skip to main content
GET
/
v3
/
credits
/
definitions
/
{definition}
Read Credit Definition
curl --request GET \
  --url http://localhost/api/v3/credits/definitions/{definition}
{
  "data": {
    "id": 123,
    "name": "<string>",
    "handle": "<string>",
    "region_id": 123,
    "region": {
      "id": 123,
      "name": "<string>",
      "handle": "<string>"
    },
    "timezone": "<string>",
    "period": 123,
    "period_type": "<string>",
    "absolute_expiry": "<string>",
    "release_period": 123,
    "release_period_type": "<string>",
    "release_period_absolute_expiry": "<string>",
    "is_published": true,
    "is_archived": true,
    "icon": "<string>",
    "image_url": "<string>",
    "primary_colour": "<string>",
    "secondary_colour": "<string>",
    "description": "<string>",
    "internal_notes": "<string>",
    "short_description": "<string>",
    "long_description": "<string>",
    "terms_conditions": "<string>",
    "earn_instructions": "<string>",
    "meta": [
      "<unknown>"
    ],
    "type": "<string>",
    "value": 123,
    "max_value": 123,
    "currency_id": 123,
    "currency": "<string>",
    "require_creator": true,
    "require_assigned": true,
    "is_extendable": true,
    "is_assignable": true,
    "is_releasable": true,
    "is_reassignable": true,
    "require_security_code": true,
    "extend_days": 123,
    "credit_number_range_type": "<string>",
    "credit_number_range_start": "<string>",
    "credit_number_range_end": "<string>",
    "credit_number_length": 123,
    "security_code_type": "<string>",
    "use_custom_numbers": true,
    "notify_schedule_offset": 123,
    "issue_target_id": 123,
    "expiry_target_id": 123,
    "release_target_id": 123,
    "remind_target_id": 123,
    "extend_target_id": 123,
    "notify_issue_offset_days": 123,
    "notify_issue_offset_hour": 123,
    "notify_remind_offset_days": 123,
    "notify_remind_offset_hour": 123,
    "tags": [
      "<string>"
    ],
    "created_at": "<string>",
    "updated_at": "<string>",
    "custom_fields": [
      {
        "name": "<string>",
        "handle": "<string>",
        "namespace": "<string>",
        "value": "<string>",
        "type": "<string>",
        "custom_fieldable_type": "<string>",
        "custom_fieldable_id": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>",
        "version": "<string>",
        "is_index": "<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

CreditDefinition

data
CreditDefinition · object
required