List all broadcast messages

GET

/api/v4/broadcast_messages

• GitLab REST API

Lists all broadcast messages for the instance.

Authorizations

• http
• oauth2

Parameters

Query Parameters

page

integer

default: 1 nullable

Current page number

Example

1

per_page

integer

default: 20 nullable

Number of items per page

Example

20

Responses

200

OK

Media type application/json

object

id

integer format: int64

message

string

starts_at

string format: date-time

ends_at

string format: date-time

color

string

font

string

target_access_levels

array

target_path

string

broadcast_type

string

theme

string

dismissable

boolean

active

boolean

Example

{
  "message": "Example broadcast message",
  "starts_at": "2016-01-04T15:39:55.570Z",
  "ends_at": "2016-01-06T15:39:55.570Z",
  "color": "#E75E40",
  "font": "#FFFFFF",
  "target_access_levels": [
    10,
    30
  ],
  "target_path": "*/welcome",
  "broadcast_type": "banner",
  "theme": "indigo"
}

400

Bad Request