Skip to content

Get list of wallpapers
Stable

Request

Returns a paginated list of all wallpaper images uploaded to the enterprise. Each result includes the image URL, thumbnail URL, orientation, and active status. Wallpapers can be uploaded directly via the API or may have been added through a blueprint configuration.

Response fields of note

id — UUID identifying the wallpaper; used to reference it in Windows blueprint wallpaper settings

image_file — URL of the full-resolution wallpaper image

thumbnail — URL of the thumbnail preview

orientation — Orientation of the image (e.g., landscape)

is_active — Whether the wallpaper is currently active

created_on / updated_on — Timestamps for auditing purposes

Common Use Cases

Discovering wallpaper_id values to reference in Windows blueprint homescreen or lock screen wallpaper settings

Verifying a wallpaper was successfully uploaded before referencing it in a blueprint

Building wallpaper selection UIs in custom management tools

Best Practices

Use timestamp filters to scope results when auditing recently added or modified wallpapers rather than fetching the full list

Store wallpaper_id UUIDs for use in Windows blueprint configuration — the wallpaper_id field appears in both homescreen and lock screen landscape settings

Note that wallpapers uploaded as part of a blueprint configuration will also appear in this list and can be reused across multiple blueprints

Security
esper_cloud_api_apiKey
Path
enterprise_idstringrequired

A UUID string identifying this enterprise.

Query
created_on_gtstring, (datetime)

Filter applications created after a given timestamp.

created_on_ltstring, (datetime)

Filter applications created before a given timestamp.

updated_on_gtstring, (datetime)

Filter applications updated after a given timestamp.

updated_on_ltstring, (datetime)

Filter applications updated before a given timestamp.

limitinteger

Number of results to return per page.

Default:20
offsetinteger

Return results from this index.

Default:0
cURL
curl -i -X GET \
  'https://api.esper.io/_mock/openapi/v1/enterprise/{enterprise_id}/wallpaper/?created_on_gt=string&created_on_lt=string&updated_on_gt=string&updated_on_lt=string&limit=20&offset=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful operation

Bodyapplication/json
countintegerrequired
nextstring or null, (url)
previousstring or null, (url)
resultsArray of objects(esper_cloud_api_Wallpaper)required
Response
{ "count": 0, "next": "string", "previous": "string", "results": [ {} ] }