# info.description
The **Reward Service API** is used for reward campaigns in Rehive.
                    

# paths./admin/campaigns/.get.parameters[].description
A page number within the paginated result set.

# paths./admin/currencies/.get.parameters[].description
A page number within the paginated result set.

# paths./admin/rewards/.get.parameters[].description
A page number within the paginated result set.

# paths./admin/users/.get.parameters[].description
A page number within the paginated result set.

# paths./user/campaigns/.get.parameters[].description
A page number within the paginated result set.

# paths./user/rewards/.get.parameters[].description
A page number within the paginated result set.

# components.schemas.ActionResponse.description
This serializer can be used if only a `status` is required in the response.

# components.schemas.AdminCampaign.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.AdminCampaign.properties.type.description
* `percentage` - Percentage
* `fixed` - Fixed
* `fixedpercentage` - Fixedpercentage

# components.schemas.AdminCampaign.properties.default_status.description
* `pending` - Pending
* `accepted` - Accepted
* `rejected` - Rejected

# components.schemas.AdminCampaign.properties.timeframe.description
* `daily` - Daily
* `weekly` - Weekly
* `monthly` - Monthly

# components.schemas.AdminCampaign.properties.event.description
* `currency.create` - currency.create
* `currency.update` - currency.update
* `user.create` - user.create
* `user.update` - user.update
* `user.password.reset` - user.password.reset
* `user.password.set` - user.password.set
* `user.email.verify` - user.email.verify
* `user.mobile.verify` - user.mobile.verify
* `email.create` - email.create
* `email.update` - email.update
* `mobile.create` - mobile.create
* `mobile.update` - mobile.update
* `address.create` - address.create
* `address.update` - address.update
* `document.create` - document.create
* `document.update` - document.update
* `bank_account.create` - bank_account.create
* `bank_account.update` - bank_account.update
* `crypto_account.create` - crypto_account.create
* `crypto_account.update` - crypto_account.update
* `transaction.create` - transaction.create
* `transaction.update` - transaction.update
* `transaction.initiate` - transaction.initiate
* `transaction.execute` - transaction.execute
* `mfa.sms.verify` - mfa.sms.verify

# components.schemas.AdminCompany.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.AdminCreateReward.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.AdminCreateReward.properties.status.description
* `pending` - Pending
* `accepted` - Accepted
* `rejected` - Rejected

# components.schemas.AdminCreateUpdateCampaign.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.AdminCreateUpdateCampaign.properties.type.description
* `percentage` - Percentage
* `fixed` - Fixed
* `fixedpercentage` - Fixedpercentage

# components.schemas.AdminCreateUpdateCampaign.properties.default_status.description
* `pending` - Pending
* `accepted` - Accepted
* `rejected` - Rejected

# components.schemas.AdminCreateUpdateCampaign.properties.timeframe.description
* `daily` - Daily
* `weekly` - Weekly
* `monthly` - Monthly

# components.schemas.AdminCreateUpdateCampaign.properties.event.description
* `currency.create` - currency.create
* `currency.update` - currency.update
* `user.create` - user.create
* `user.update` - user.update
* `user.password.reset` - user.password.reset
* `user.password.set` - user.password.set
* `user.email.verify` - user.email.verify
* `user.mobile.verify` - user.mobile.verify
* `email.create` - email.create
* `email.update` - email.update
* `mobile.create` - mobile.create
* `mobile.update` - mobile.update
* `address.create` - address.create
* `address.update` - address.update
* `document.create` - document.create
* `document.update` - document.update
* `bank_account.create` - bank_account.create
* `bank_account.update` - bank_account.update
* `crypto_account.create` - crypto_account.create
* `crypto_account.update` - crypto_account.update
* `transaction.create` - transaction.create
* `transaction.update` - transaction.update
* `transaction.initiate` - transaction.initiate
* `transaction.execute` - transaction.execute
* `mfa.sms.verify` - mfa.sms.verify

# components.schemas.AdminReward.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.AdminReward.properties.status.description
* `pending` - Pending
* `accepted` - Accepted
* `rejected` - Rejected

# components.schemas.AdminUser.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.Campaign.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.Currency.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.PatchedAdminCompany.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.PatchedAdminCreateUpdateCampaign.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.PatchedAdminCreateUpdateCampaign.properties.type.description
* `percentage` - Percentage
* `fixed` - Fixed
* `fixedpercentage` - Fixedpercentage

# components.schemas.PatchedAdminCreateUpdateCampaign.properties.default_status.description
* `pending` - Pending
* `accepted` - Accepted
* `rejected` - Rejected

# components.schemas.PatchedAdminCreateUpdateCampaign.properties.timeframe.description
* `daily` - Daily
* `weekly` - Weekly
* `monthly` - Monthly

# components.schemas.PatchedAdminCreateUpdateCampaign.properties.event.description
* `currency.create` - currency.create
* `currency.update` - currency.update
* `user.create` - user.create
* `user.update` - user.update
* `user.password.reset` - user.password.reset
* `user.password.set` - user.password.set
* `user.email.verify` - user.email.verify
* `user.mobile.verify` - user.mobile.verify
* `email.create` - email.create
* `email.update` - email.update
* `mobile.create` - mobile.create
* `mobile.update` - mobile.update
* `address.create` - address.create
* `address.update` - address.update
* `document.create` - document.create
* `document.update` - document.update
* `bank_account.create` - bank_account.create
* `bank_account.update` - bank_account.update
* `crypto_account.create` - crypto_account.create
* `crypto_account.update` - crypto_account.update
* `transaction.create` - transaction.create
* `transaction.update` - transaction.update
* `transaction.initiate` - transaction.initiate
* `transaction.execute` - transaction.execute
* `mfa.sms.verify` - mfa.sms.verify

# components.schemas.PatchedAdminReward.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.PatchedAdminReward.properties.status.description
* `pending` - Pending
* `accepted` - Accepted
* `rejected` - Rejected

# components.schemas.PatchedUserUpdateReferral.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.User.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.UserCampaign.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.UserCreateReward.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.UserReward.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.UserUpdateReferral.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.Webhook.properties.event.description
* `currency.create` - currency.create
* `currency.update` - currency.update
* `user.create` - user.create
* `user.update` - user.update
* `user.password.reset` - user.password.reset
* `user.password.set` - user.password.set
* `user.email.verify` - user.email.verify
* `user.mobile.verify` - user.mobile.verify
* `email.create` - email.create
* `email.update` - email.update
* `mobile.create` - mobile.create
* `mobile.update` - mobile.update
* `address.create` - address.create
* `address.update` - address.update
* `document.create` - document.create
* `document.update` - document.update
* `bank_account.create` - bank_account.create
* `bank_account.update` - bank_account.update
* `crypto_account.create` - crypto_account.create
* `crypto_account.update` - crypto_account.update
* `transaction.create` - transaction.create
* `transaction.update` - transaction.update
* `transaction.initiate` - transaction.initiate
* `transaction.execute` - transaction.execute
* `mfa.sms.verify` - mfa.sms.verify

# components.securitySchemes.apiAuth.description
Token-based HTTP Authentication scheme.
Include an API token in the `Authorization` header using the format: `Token <your-api-key>`.