Skip to content

Get instance of wallpaper
Stable

Request

Returns the details of a single wallpaper image identified by its UUID wallpaper_id, including the full-resolution image URL, thumbnail URL, orientation, and active status. There is no dedicated wallpaper library in the Console — wallpapers are only visible by previewing the blueprint they are associated with, making this endpoint the primary way to retrieve details for a specific wallpaper programmatically.

Response fields of note

id — UUID identifying the wallpaper

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

Retrieving wallpaper details to confirm a successful upload before referencing the wallpaper_id in a blueprint

Auditing the metadata of a specific wallpaper when the wallpaper_id is already known

Verifying the orientation or active status of a wallpaper before assigning it to a Windows blueprint

Best Practices

If the wallpaper_id is not already known, use GET /v1/enterprise/{enterprise_id}/wallpaper/ with timestamp filters to locate it — wallpapers are not browsable in the Console

This endpoint returns metadata and image URLs only; the image itself must be accessed directly via the image_file URL in the response

Security
esper_cloud_api_apiKey
Path
enterprise_idstringrequired

A UUID string identifying this enterprise.

wallpaper_idstringrequired

A UUID string identifying the wallpaper.

cURL
curl -i -X GET \
  'https://api.esper.io/_mock/openapi/v1/enterprise/{enterprise_id}/wallpaper/{wallpaper_id}/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful operation

Bodyapplication/json
idstring, (uuid)
enterprisestring, (uuid)
image_filestring, (url)
thumbnailstring, (url)
orientationstring
is_activeboolean
created_onstring, (date-time)
updated_onstring, (date-time)
Response
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9", "image_file": "string", "thumbnail": "string", "orientation": "string", "is_active": true, "created_on": "2019-08-24T14:15:22Z", "updated_on": "2019-08-24T14:15:22Z" }