Skip to content
Pasqal Documentation

Get All Banners

GET
/api/v1/banners

Parameters

Query Parameters

only_active
Only Active

If True, returns only active banners. Default: False

boolean

If True, returns only active banners. Default: False

limit
Limit
integer
default: 100 > 0 < 101
offset
Offset
integer
order_by
Order By
string
default: created_at
order_by_direction
string
Allowed values: ASC DESC

Responses

200

Successful Response

HeaderPaginatedResponse[ProducedBannerResponse]

A list of responses with pagination information.

For backwards compatibility, this also exposes pagination using the following header format:

Access-Control-Expose-Headers: Content-Range
Content-Range: $FIRST_ITEM_IN_BATCH-$LAST_ITEM_IN_BACH/$TOTAL_ITEMS_AVAILABLE
object
status
string
Allowed values: success fail error
message
Message
string
default: OK.
code
Code
string
default: 200
data
required
Data
Array<object>
ProducedBannerResponse

Response to a request for banners to display on a page

object
id
required
Id
string format: uuid
banner_message
required
Banner Message
string
start_datetime
required
Start Datetime
string format: date-time
end_datetime
required
End Datetime
string format: date-time
level
required
BannerLevel

An enumeration.

string
Allowed values: INFO WARNING
pagination
required
JSendPagination

Pagination information

object
total
required
Total
integer
start
required
Start
integer
end
required
End
integer

422

Validation Error

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