GIgitlab
broadcast_messages

List all broadcast messages

Lists all broadcast messages for the instance.

get/api/v4/broadcast_messages

Request

  • Base URL
    https://gitlab.com
  • Auth
    none declared

Query parameters

pageinteger

Current page number

per_pageinteger

Number of items per page

Response

List all broadcast messages

idinteger required
messagestring required
starts_atstring date-time required
ends_atstring date-time required
colorstring required
fontstring required
target_pathstring required
broadcast_typestring required
themestring required
dismissableboolean required
activeboolean required

Example response

{
  "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"
}

Changes

No recorded changes to this operation across all 5 revisions of this API.