Skip to main content
GET
List welcome messages

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Query Parameters

page
integer
default:1

The collection page number

itemsPerPage
integer
default:100

The number of items per page

Required range: 0 <= x <= 100
pagination
boolean

Enable or disable pagination

order[dateCreated]
enum<string>
default:asc
Available options:
asc,
desc
order[dateUpdated]
enum<string>
default:asc
Available options:
asc,
desc
order[id]
enum<string>
default:asc
Available options:
asc,
desc

Response

200 - application/json

DashboardWelcomeMessage collection

id
integer
read-only
tenant
string<iri-reference>
Example:

"/api/v1/tenants/1"

selectedUserTypeIds
(string | null)[] | null
message
string | null
imageUrl
string | null
dateCreated
string<date-time> | null
dateUpdated
string<date-time> | null
default
boolean | null
read-only
sticky
boolean | null