Skip to content
Pasqal Documentation

Get All Banners

GET
/api/v1/banners

Parameters

Query Parameters

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

Responses

200

Successful Response

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
string
default: OK.
code
string
default: 200
data
required
Array<object>

Response to a request for banners to display on a page

object
id
required
string format: uuid
banner_message
required
string
start_datetime
required
string format: date-time
end_datetime
required
string format: date-time
level
required

An enumeration.

string
Allowed values: INFO WARNING
pagination
required

Pagination information

object
total
required
integer
start
required
integer
end
required
integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string