Get one ImageFile

GET

api

content

imagefiles

{id}

Get one ImageFile

curl --request GET \
  --url https://spaces.nexudus.com/api/content/imagefiles/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/content/imagefiles/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/content/imagefiles/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "BusinessWebAddress": "<string>",
  "Name": "<string>",
  "Description": "<string>",
  "UseInGallery": true,
  "ImageFileName": "<string>",
  "NewImageUrl": "<string>",
  "ClearImageFile": true,
  "FileSizeBytes": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

An ImageFile represents an uploaded image stored in the system. Image files can be used for branding, content, floor plans, or other visual elements across the platform.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the ImageFile-Read role.

Path Parameters

integer

required

The Id of the ImageFile record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/content/imagefiles/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/content/imagefiles/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/content/imagefiles/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the business linked to this record.

string

Display name of the linked business (read-only).

string

The business web address value for this image file.

string

The name value for this image file.

string

Free-text description of this image file.

boolean

Whether use in gallery is enabled.

string

Current file name of the image (read-only; upload via the corresponding URL field).

string

URL of a new file to upload as the image.

boolean

Set to true to remove the current image file.

integer

The file size bytes value for this image file.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "BusinessId": 0,
  "BusinessName": null,
  "BusinessWebAddress": null,
  "Name": "",
  "Description": null,
  "UseInGallery": false,
  "ImageFileName": null,
  "NewImageUrl": null,
  "ClearImageFile": null,
  "FileSizeBytes": null,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "ImageFile Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get multiple ImageFilesRetrieve multiple ImageFile records by their Ids in a single request.

Get one ImageFile

curl --request GET \
  --url https://spaces.nexudus.com/api/content/imagefiles/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/content/imagefiles/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/content/imagefiles/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "BusinessWebAddress": "<string>",
  "Name": "<string>",
  "Description": "<string>",
  "UseInGallery": true,
  "ImageFileName": "<string>",
  "NewImageUrl": "<string>",
  "ClearImageFile": true,
  "FileSizeBytes": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200