Get one DataFile

GET

api

content

datafiles

{id}

Get one DataFile

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

import requests

url = "https://spaces.nexudus.com/api/content/datafiles/{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/datafiles/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "Name": "<string>",
  "Description": "<string>",
  "FileDataFileName": "<string>",
  "NewFileDataUrl": "<string>",
  "ClearFileDataFile": true,
  "FileSizeBytes": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A DataFile stores a general-purpose file that can be referenced in the members portal, invoices, or email messages and templates sent to customers. URLs for stored files are public. Use NewFileDataUrl to attach a file from a URL during create or update, and ClearFileDataFile to remove the currently attached file.

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 DataFile-Read role.

Path Parameters

integer

required

The Id of the DataFile record to retrieve.

Code Examples

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

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

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/content/datafiles/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 file.

string

Optional description of the file.

string

Original filename of the uploaded file.

string

Public URL pointing to the file to upload. Set during create or update to attach a new file.

boolean

Set to true to remove the currently attached file.

integer

Size of the uploaded file in bytes.

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,
  "Name": "",
  "Description": null,
  "FileDataFileName": null,
  "NewFileDataUrl": null,
  "ClearFileDataFile": 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": "DataFile Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get multiple DataFilesRetrieve multiple DataFile records by their Ids in a single request.

Get one DataFile

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

import requests

url = "https://spaces.nexudus.com/api/content/datafiles/{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/datafiles/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "Name": "<string>",
  "Description": "<string>",
  "FileDataFileName": "<string>",
  "NewFileDataUrl": "<string>",
  "ClearFileDataFile": 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