Skip to content
BoxBilling

List notifications

GET
/v1/notifications/

List notifications with optional filters.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
skip
Skip
integer
0
limit
Limit
integer
default: 50 >= 1 <= 200
category
Any of:
string
is_read
Any of:
boolean
order_by
Any of:
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Response List Notifications V1 Notifications Get
Array<object>
NotificationResponse
object
id
required
Id
string format: uuid
organization_id
required
Organization Id
string format: uuid
category
required
Category
string
title
required
Title
string
message
required
Message
string
resource_type
required
Any of:
string
resource_id
required
Any of:
string format: uuid
is_read
required
Is Read
boolean
created_at
required
Created At
string format: date-time

401

Section titled “401 ”

Unauthorized – invalid or missing API key

422

Section titled “422 ”

Validation Error

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