# info.description
The **Notification Service API** is used for sending email, SMS, and push notifications in Rehive.
                    

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

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

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

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

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

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

# paths./user/notifications/.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.Activate.description
Serialize the activation data, should be a token that represents an admin
user.

# components.schemas.AdminCompany.properties.mode.description
* `test` - Test
* `production` - Production

# components.schemas.AdminCreateUpdateNotification.description
Serialize notifications, create, update and delete.

# components.schemas.AdminCreateUpdateNotification.properties.type.description
* `email` - email
* `sms` - sms
* `push` - push

# components.schemas.AdminCredential.description
Serialize notifications, create, update and delete.

# components.schemas.AdminCredential.properties.credential_type.description
* `twilio` - twilio
* `sendgrid` - sendgrid

# components.schemas.AdminLog.properties.type.description
* `email` - email
* `sms` - sms
* `push` - push

# components.schemas.AdminNotification.description
Serialize notifications, create, update and delete.

# components.schemas.AdminNotification.properties.type.description
* `email` - email
* `sms` - sms
* `push` - push

# components.schemas.AdminReducedTemplate.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.AdminTemplate.properties.type.description
* `email` - email
* `sms` - sms
* `push` - push

# components.schemas.Deactivate.description
Serialize the deactivation data, should be a token that represents an admin
user.

# components.schemas.LayoutTemplate.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.LayoutTemplate.properties.type.description
* `email` - email
* `sms` - sms
* `push` - push

# components.schemas.NotificationLayout.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.NotificationLayout.properties.type.description
* `email` - email
* `sms` - sms
* `push` - push

# components.schemas.PatchedAdminCompany.properties.mode.description
* `test` - Test
* `production` - Production

# components.schemas.PatchedAdminCreateUpdateNotification.description
Serialize notifications, create, update and delete.

# components.schemas.PatchedAdminCreateUpdateNotification.properties.type.description
* `email` - email
* `sms` - sms
* `push` - push

# components.schemas.PatchedAdminCredential.description
Serialize notifications, create, update and delete.

# components.schemas.PatchedAdminCredential.properties.credential_type.description
* `twilio` - twilio
* `sendgrid` - sendgrid

# components.schemas.PatchedNotificationLayout.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.PatchedNotificationLayout.properties.type.description
* `email` - email
* `sms` - sms
* `push` - push

# components.schemas.PatchedUserUpdateNotification.description
Serialize notifications update. Actually updates the notification
preference instead.

# components.schemas.ReducedLayoutTemplate.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.ReducedNotificationLayout.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.UserUpdateNotification.description
Serialize notifications update. Actually updates the notification
preference instead.

# components.schemas.Webhook.description
Validate and serialize the webhook data. The secret key and company are
used to identify a specific company.

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