Skip to navigation

Get Member Image

Retrieve the image associated with a specific member.

Authentication

x-np-api-keystring
API Key authentication via header

Path parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

memberIdUUIDRequired
Unique identifier for a member.

Headers

x-api-versiondateOptional

Used for API versioning. More details.

Query parameters

sizeenumOptional

The size of the member image thumbnail to retrieve. Small images are not upscaled, and some image types may compress better at different sizes. Defaults to large (360px) when unspecified, with fallback to medium (240px) and then original. small (70px) are suitable for lists. original returns the original image as uploaded, which may be very large. embedded returns a smaller embedded version of the original image, suitable for use in documents

Allowed values:

Response

This endpoint returns an object.
imagestring

A Base64-encoded image string or a URL to the image.

Change effective from 2025-10-27:
The image property now contains a complete image source string instead of raw Base64 data.

Depending on tenant configuration:

  • Tenants with Business Central natively hosted image storage receive a Base64-encoded Data URI, e.g. data:image/jpeg;base64,<encoded data>
  • Tenants with hosted image storage receive an HTTPS URL, e.g. https://image-service.example.com/<imagename>.jpg. The URL is time-limited and secured.

Both formats can be used directly in an <img src> attribute.
Clients that previously decoded the Base64 manually should update accordingly.