Pular para o conteúdo
Healthing CRM

List Notifications

GET
/api/v1/notifications

List notifications for current user with pagination and filters.

Authorizations

Seção intitulada “Authorizations ”

Parameters

Seção intitulada “ Parameters ”

Query Parameters

Seção intitulada “Query Parameters ”
page
Page
integer
default: 1 >= 1
per_page
Per Page
integer
default: 20 >= 1 <= 100
is_read
Any of:
boolean
type
Any of:
NotificationType

Notification type enum.

string
Allowed values: info success warning error message

Header Parameters

Seção intitulada “Header Parameters ”
x-tenant-id
Any of:
integer

Responses

Seção intitulada “ Responses ”

200

Seção intitulada “200 ”

Successful Response

NotificationListResponse

List notifications response schema.

object
notifications
required
Notifications
Array<object>
NotificationResponse

Notification response schema.

object
type
string
Allowed values: info success warning error message
icon
string
Allowed values: bell mail calendar users building check alert
title
required
Title
string
>= 1 characters <= 500 characters
message
required
Message
string
>= 1 characters
link
Any of:
string
<= 1000 characters
entity_type
Any of:
string
<= 50 characters
entity_id
Any of:
integer
id
required
Id
integer
user_id
required
User Id
integer
is_read
required
Is Read
boolean
read_at
required
Any of:
string format: date-time
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
total
required
Total
integer
page
required
Page
integer
per_page
required
Per Page
integer
unread_count
required
Unread Count
integer

422

Seção intitulada “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string