Skip to content

Get the background image key status

GET
/api/v1/admin/appearance/unsplash-key
curl --request GET \
--url https://example.com/api/v1/admin/appearance/unsplash-key \
--header 'Authorization: Bearer <token>'

Returns the background image key status. It requires a signed-in User with the admin scope and the admin or owner Role. It can return 401 if the session is missing or expired and 403 if access is denied. Route: /api/v1/admin/appearance/unsplash-key. Inputs: . Safe reads can use bounded retries.

Media typeapplication/json

The admin API exposes whether a key exists, never the key itself.

object
configured
required
boolean
Examplegenerated
{
"configured": true
}